HOhookdeck
Attempts

Get Attempt

Changed on

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}

Request

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

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 destination object, without credentials

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

latency_msinteger nullable

Time in milliseconds from sending the attempt to receiving the destination's response (or the error), measured around the provider's publish call. Null for attempts that never reached the provider and for attempts recorded before latency was tracked.

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,
  "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

  • c7b12e3724c0Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed discriminator from response property for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 00e66862a43bRevision changes
    • info

      added the optional property to the response with the status