Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-102991198.1 KB
Attempts

Get Attempt

Retrieves details for a specific attempt.

When authenticated with a Tenant JWT, only attempts belonging to that tenant can be accessed. When authenticated with Admin API Key, attempts from any tenant can be accessed.

get/attempts/{attempt_id}

Query parameters

tenant_idstring

Filter by tenant ID. Returns 404 if the attempt does not belong to the specified tenant. Ignored when using Tenant JWT authentication.

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

Response

Attempt details.

idstring

Unique identifier for this attempt.

tenant_idstring

The tenant this attempt belongs to.

status'success' | 'failed'

The attempt status.

timestring date-time

Time the attempt was made.

codestring

Response status code or error code.

response_dataobject nullable

Response data from the attempt. Only included when include=response_data.

attempt_numberinteger

The attempt number (1 for first attempt, 2+ for retries).

manualboolean

Whether this attempt was manually triggered (e.g., a retry initiated by a user).

event_idstring

The ID of the associated event.

destination_idstring

The destination ID this attempt was sent to.

Example response

{
  "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"
    },
    "data": {
      "user_id": "userid",
      "status": "active"
    }
  },
  "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"
    }
  }
}