Sign in
Attempts

List Attempts

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

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'

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).

time[gte]string date-time

Filter attempts by event time >= value (RFC3339 or YYYY-MM-DD format).

time[lte]string date-time

Filter attempts by event time <= value (RFC3339 or YYYY-MM-DD format).

time[gt]string date-time

Filter attempts by event time > value (RFC3339 or YYYY-MM-DD format).

time[lt]string date-time

Filter attempts by event time < value (RFC3339 or YYYY-MM-DD format).

limitinteger

Number of items per page (default 100, max 1000).

nextstring

Cursor for next page of results.

prevstring

Cursor for previous page of results.

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 full destination object
order_by'time'

Field to sort by.

dir'asc' | 'desc'

Sort direction.

Response

A paginated list of attempts.

Example response

{
  "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,
      "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"
        }
      },
      "destination": {
        "id": "des_webhook_123",
        "type": "webhook",
        "topics": [
          "user.created",
          "order.shipped"
        ],
        "disabled_at": null,
        "created_at": "2024-02-15T10:00:00Z",
        "updated_at": "2024-02-15T10:00:00Z",
        "config": {
          "url": "https://my-service.com/webhook/handler"
        },
        "credentials": {
          "secret": "whsec_abc123def456",
          "previous_secret": "whsec_prev789xyz012",
          "previous_secret_invalid_at": "2024-02-16T10:00:00Z"
        }
      }
    }
  ],
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100,
    "next": "MTcwNDA2NzIwMA=="
  }
}

Changes