Skip to content

The Webhook History Object

A webhook history entry records one delivery attempt of one event to one of your webhooks. Use it to see what was sent, how your endpoint answered, and whether a retry is still pending.

Required scope (OAuth only): view-webhook-history-events

Attributes

ParameterTypeDescription
objectstringAlways v2.webhook_history.
idstringThe unique identifier for the history entry.
webhook_idstringThe identifier of the webhook the event was delivered to.
event_namestringThe event that was delivered, for example transaction.paid.
statusstringsuccess when the last response was a 2xx, otherwise failed.
urlstringThe URL the event was delivered to, as it was at the time of delivery.
entity_idstringThe identifier of the resource the event is about, for example the transaction id.
dataobjectThe payload that was sent to your endpoint.
attemptsintegerHow many delivery attempts have been made.
max_attemptsintegerThe maximum number of attempts before delivery is abandoned.
will_retrybooleanWhether another attempt is scheduled.
response.status_codeinteger|nullHTTP status code returned by your endpoint on the last attempt.
response.bodystring|nullResponse body returned by your endpoint on the last attempt.
last_attempted_atstring|nullDate and time of the last delivery attempt.
created_atstring|nullDate and time the event was first queued for delivery.

Request

Endpoint: https://youcanpay.com/api/v2/webhook-history/{webhook_history_id}Method: GET

bash
$ curl --location -g --request GET 'https://youcanpay.com/api/v2/webhook-history/6f2e1a0b-7c8d-4e9f-a0b1-c2d3e4f5a6b7' \
  --header 'Accept: application/json' \
  -u 'YOUR_PRIVATE_KEY:'

Response

json
{
  "object": "v2.webhook_history",
  "id": "6f2e1a0b-7c8d-4e9f-a0b1-c2d3e4f5a6b7",
  "webhook_id": "9b1f2c34-5d6e-4a7b-8c9d-0e1f2a3b4c5d",
  "event_name": "transaction.paid",
  "status": "failed",
  "url": "https://example.com/webhooks/youcan-pay",
  "entity_id": "10e7691c-14a2-4936-833b-ec154c817ce9",
  "data": {
    "id": "f9dc2ad2-a2ac-4608-878c-066f5ceb2ab3",
    "event_name": "transaction.paid",
    "sandbox": false,
    "payload": {}
  },
  "attempts": 2,
  "max_attempts": 3,
  "will_retry": true,
  "response": {
    "status_code": 500,
    "body": "Internal Server Error"
  },
  "last_attempted_at": "2026-09-09 12:10:44",
  "created_at": "2026-09-09 11:58:02"
}