HOhookdeck
Attempts

List Attempts

Changed on

Retrieves a paginated list of attempts.

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

get/attempts

Request

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

Query parameters

string
OR
string[]

Filter attempts 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 attempts from all tenants.

string
OR
string[]

Filter attempts by event ID(s). Use bracket notation for multiple values (e.g., event_id[0]=e1&event_id[1]=e2).

string
OR
string[]

Filter attempts by destination ID(s). Use bracket notation for multiple values (e.g., destination_id[0]=d1&destination_id[1]=d2).

'webhook' | 'aws_sqs' | 'rabbitmq' | 'hookdeck' | 'aws_kinesis' | 'azure_servicebus' | 'aws_s3' | 'gcp_pubsub' | 'kafka' | 'cloudflare_queues' | 'aws_eventbridge'

Type of destination.

OR
DestinationType[]
Example:webhook

Filter attempts by destination type(s). Use bracket notation for multiple values (e.g., destination_type[0]=webhook&destination_type[1]=aws_sqs).

status'success' | 'failed'

Filter attempts by status.

string
OR
string[]

Filter attempts by event 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 attempts by event 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.

string
OR
string[]

Fields to include in the response. Use bracket notation for multiple values (e.g., include[0]=event&include[1]=response_data).

  • event: Include event summary (id, topic, time, eligible_for_retry, metadata)
  • event.data: Include full event with payload data
  • response_data: Include response body and headers
  • destination: Include the destination object, without credentials
order_by'time'

Field to sort by.

dir'asc' | 'desc'

Sort direction.

Response

A paginated list of attempts.

Example response

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100,
    "next": "MTcwNDA2NzIwMA=="
  },
  "models": [
    {
      "id": "atm_123",
      "tenant_id": "tnt_123",
      "status": "success",
      "time": "2024-01-01T00:00:05Z",
      "code": "200",
      "response_data": {
        "status_code": 200,
        "body": "{\"status\":\"ok\"}",
        "headers": {
          "content-type": "application/json"
        }
      },
      "attempt_number": 1,
      "latency_ms": 212,
      "event_id": "evt_123",
      "destination_id": "des_456",
      "event": {
        "id": "evt_123",
        "tenant_id": "tnt_123",
        "destination_id": "des_456",
        "topic": "user.created",
        "time": "2024-01-01T00:00:00Z",
        "eligible_for_retry": true,
        "metadata": {
          "source": "crm"
        },
        "data": {
          "user_id": "userid",
          "status": "active"
        }
      },
      "destination": {
        "id": "des_12345",
        "tenant_id": "tenant_123",
        "type": "webhook",
        "filter": {
          "data": {
            "amount": {
              "$gte": 100
            },
            "customer": {
              "tier": "premium"
            }
          }
        },
        "config": {
          "url": "https://my-service.com/webhook/handler"
        },
        "delivery_metadata": {
          "app-id": "my-app",
          "region": "us-east-1"
        },
        "metadata": {
          "internal-id": "123",
          "team": "platform"
        },
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z",
        "target": "my-service.com",
        "target_url": "https://my-service.com/webhook/handler"
      }
    }
  ]
}

Changes

  • 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

  • 85a4143bcd92Revision changes
    • info

      added the enum value aws_eventbridge to the property oneOf[DestinationType]/ of the query request parameter destination_type

    • info

      added the enum value aws_eventbridge to the property oneOf[subschema #2]/items/ of the query request parameter destination_type