Webhooks

Retrieve a webhook delivery

Changed on

Retrieve a webhook delivery’s status and original payload.

get/webhooks/deliveries/{delivery_id}

Request

  • Base URL: https://api.context.dev/v1
  • URL: https://api.context.dev/v1/webhooks/deliveries/{delivery_id}
  • Auth: HTTP bearer

Path parameters

delivery_idstring required

Delivery ID.

Query parameters

tagsstring[]

Labels for filtering usage in the dashboard.

Comma-separated labels for filtering usage, e.g. production,team-alpha.

[
  "production",
  "team-alpha"
]

Response

Webhook delivery

idstring required

Delivery ID.

event'batch.completed' | 'batch.failed' | 'batch.cancelled' | 'change.detected' | 'run.completed' required

Webhook event type.

urlstring uri required

Webhook destination URL.

status'pending' | 'delivering' | 'retrying' | 'delivered' | 'failed' | 'cancelled' required

pending, delivering, retrying, delivered, failed, or cancelled (source or its webhook was removed).

created_atstring date-time required

Event creation time.

retry_expires_atstring date-time required

Last time you can retry manually (7 days after the event).

delivered_atstring date-time nullable required

Last successful delivery time, or null if never delivered.

next_attempt_atstring date-time nullable required

Next scheduled attempt, or null if none.

event_idstring required

Stable event ID for deduplicating received webhooks.

request_idstring uuid required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example response

{
  "retry": {
    "delays_seconds": [
      10,
      60,
      300,
      1800,
      7200,
      21600,
      57600
    ]
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
}

Changes

  • 61627728926bRevision changes
    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

  • 4ddcf49b9fe5Revision changes
    • 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

      added the optional property to the response with the status