Skip to main content
Webhook deliveries

Read webhook delivery

GET/v4/config/platform/webhooks/{webhookId}/delivery/{deliveryId}

Returns one delivery of a webhook: its status and the answer to its last attempt. The delivery object is the whole body, with no wrapper member. Get the deliveryId from List webhook deliveries or from the X-IGrant-Delivery-Id header of a delivery.

The answer has no webhookEventType and no attempt (the list has them). The service keeps the request headers, the body and the answer body of a delivery, but no operation returns them.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:webhooks:read

Path parameters

  • webhookIdstringrequired

    The id of the webhook, from Create webhook or List all webhooks.

    Example:"68a1f2c3d4e5f6a7b8c9d0e1"

  • deliveryIdstringrequired

    The id of the delivery, from List webhook deliveries, the X-IGrant-Delivery-Id header of an ows.* event, or the deliveryID member of a consent management or data marketplace event.

    Example:"68a1f2c3d4e5f6a7b8c9d0e2"

Response

application/json

The delivery.

  • idstring

    The id of the delivery. For an ows.* event it is the X-IGrant-Delivery-Id header of each attempt; for a consent management or data marketplace event, the deliveryID member of the body.

    Example:"68a1f2c3d4e5f6a7b8c9d0e1"

  • webhookIdstring

    The webhook of the delivery.

  • webhookEventTypestring

    The event type. Only the delivery list sends it.

    Example:"ows.issuer.issuance_history.credential_issued"

  • attemptinteger

    The number of the last attempt: 1 to 7 for an ows.* event, 0 while it waits for its first attempt. A consent management or data marketplace event has 1 (it gets 1 attempt). Only the delivery list sends it.

    Example:1

  • responseStatusCodeinteger<int32>

    The HTTP status code of the answer to the last attempt. 0 when the payload URL did not answer (a timeout or a connection error) or no attempt ran yet.

    Example:200

  • responseStatusStrstring

    The HTTP status line of the answer to the last attempt, for example 200 OK. An empty string when the payload URL did not answer.

    Example:"200 OK"

  • timestampstring

    When the last attempt started (UTC, YYYY-MM-DDThh:mm:ssZ). For a pending delivery, when the service queued it.

    Example:"2026-08-09T10:11:12Z"

  • statusenum<string>

    Where the delivery is. For an ows.* event: pending (it waits for its first attempt), retrying (an attempt failed and another one comes), completed (the payload URL answered 2xx within 10 seconds), failed (attempt 7 failed, or the webhook is disabled or deleted). For a consent management or data marketplace event: completed when the payload URL answered, also with an error status (read responseStatusCode), and failed when it did not answer.

    Available options:pending,retrying,completed,failed

    Example:"completed"

  • statusDescriptionstring

    Why the last attempt failed, and for retrying when the next attempt comes, for example Attempt 1 of 7 failed: the answer has the status 500. The next attempt is at 2026-08-09T10:12:12Z. An empty string when the delivery succeeded or waits for its first attempt.