Retrieve a Webhook Attempt

GET /webhooks/attempts/{attempt}

Retrieve a Webhook Attempt

cURL

curl --request GET \
  --url https://api.mintfax.com/v1/webhooks/attempts/{attempt} \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "id": "<string>",
  "event_id": "<string>",
  "webhook_endpoint_id": "<string>",
  "attempt_number": 123,
  "status_code": 123,
  "succeeded_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "error_class": "<string>",
  "error_message": "<string>",
  "parent_attempt_id": "<string>"
}

Authorizations

Authorization · string · header · required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Path Parameters

attempt · string · required

The attempt public id

Response

200

application/json

WebhookAttemptResource

id · string · required

Webhook attempt identifier (wha_-prefixed ULID).

Example:

"wha_01J9XYZQ8KH7B3R0WXAZP8VW6F"

event_id · string · required

Event identifier this attempt delivered (evt_-prefixed ULID).

webhook_endpoint_id · string · required

Webhook endpoint identifier that received this attempt.

attempt_number · integer · required

Attempt number (1-indexed).

status_code · integer | null · required

HTTP status code returned by the endpoint; null when the request never completed.

succeeded_at · string<date-time> | null · required

UTC timestamp when the attempt succeeded; null if it failed or is in flight.

failed_at · string<date-time> | null · required

UTC timestamp when the attempt failed terminally; null if it succeeded or is in flight.

error_class · string | null · required

Exception class name when delivery failed transport-level; null otherwise.

error_message · string | null · required

Failure description; null when the attempt succeeded.

parent_attempt_id · string | null · required

Identifier of the prior attempt this one retried; null for the initial delivery.