HOhookdeck
Events

List Events

Changed on

Retrieves a list of events.

When authenticated with a Tenant JWT, returns only events belonging to that tenant. When authenticated with Admin API Key, returns events across all tenants. Use tenant_id query parameter to filter by tenant.

get/events

Request

  • Base URL
    https://api.outpost.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

string
OR
string[]

Filter events by ID(s). Use bracket notation for multiple values (e.g., id[0]=abc&id[1]=def).

string
OR
string[]

Filter events by tenant ID(s). Use bracket notation for multiple values (e.g., tenant_id[0]=t1&tenant_id[1]=t2). When authenticated with a Tenant JWT, this parameter is ignored and the JWT's tenant is used. If not provided with API key auth, returns events from all tenants.

string
OR
string[]

Filter events by matched destination ID(s). Returns events that were routed to the specified destination(s). Use bracket notation for multiple values (e.g., destination_id[0]=d1&destination_id[1]=d2).

string
OR
string[]

Filter events by topic(s). Use bracket notation for multiple values (e.g., topic[0]=user.created&topic[1]=user.updated).

gtestring date-time

Filter with value >= the specified date-time.

ltestring date-time

Filter with value <= the specified date-time.

gtstring date-time

Filter with value > the specified date-time.

ltstring date-time

Filter with value < the specified date-time.

Filter events by time range using comparison operators.

limitinteger

Number of items per page (1-1000, default 100). A value outside this range, or one that is not an integer, returns a 400.

nextstring

Cursor for the next page of results, from pagination.next of a previous response. Mutually exclusive with prev. A cursor that cannot be read returns a 400.

prevstring

Cursor for the previous page of results, from pagination.prev of a previous response. Mutually exclusive with next. A cursor that cannot be read returns a 400.

order_by'time'

Field to sort by.

dir'asc' | 'desc'

Sort direction.

Response

A paginated list of events.

Example response

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100,
    "next": "MTcwNDA2NzIwMA=="
  },
  "models": [
    {
      "id": "evt_123",
      "tenant_id": "tnt_123",
      "matched_destination_ids": [
        "des_456",
        "des_789"
      ],
      "topic": "user.created",
      "time": "2024-01-01T00:00:00Z",
      "eligible_for_retry": true,
      "metadata": {
        "source": "crm"
      },
      "data": {
        "user_id": "userid",
        "status": "active"
      }
    }
  ]
}

Changes

  • a4ddd5c7a824Revision changes
    • info

      added the optional property // to the response with the status

  • 245bc66dbe5aRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status