Delete all pull events matching filters

POST

/v1/pull-endpoints/{id}/events/delete-all

curl --request POST \
  --url 'https://api.hookbridge.io/v1/pull-endpoints/01935abc-def0-7123-4567-890abcdef012/events/delete-all?limit=1000' \
  --header 'Authorization: Bearer <token>'

• Production

Soft-delete pull events matching the specified filters for the given pull endpoint. Processes in chunks for reliability. Returns the count and IDs of deleted events. On error, the response includes an error object: DELETE_FAILED if no rows were deleted, or PARTIAL_DELETE_FAILURE if some rows were committed before the error. Maximum 1000 events per request.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Pull endpoint identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Query Parameters

status

string

Comma-separated list of statuses to match (stored, fetched, delivered).

event_type

string

Exact event type to match.

received_after

string format: date-time

Only delete events received at or after this time (RFC 3339).

received_before

string format: date-time

Only delete events received before this time (RFC 3339).

limit

integer

default: 1000 >= 1 <= 1000

Maximum events to delete (1–1000, default 1000).

Responses

200

Delete-all results

Media typeapplication/json

object

data

object

deleted

required

Number of events deleted

integer

deleted_event_ids

required

IDs of deleted events

Array<string>

error

Present only on partial failure

object

code

string

Allowed values: DELETE_FAILED PARTIAL_DELETE_FAILURE

message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "data": {
    "deleted": 42,
    "deleted_event_ids": [
      "01935abc-def0-7123-4567-890abcdef012"
    ]
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

404

Resource not found

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Message not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

500

Internal server error

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An internal error occurred"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}