Rolefy

API reference / Webhooks

List a subscription's deliveries

GET/v1/webhooks/{id}/deliveries

Needs a bearer access token with the webhooks.read scope. How authentication works

The delivery log for one subscription, newest first: each event, how many attempts it took, the last response code your endpoint gave, and the last error. Use it to find out why an event never arrived.

Path parameters

  • idstring · uuidpathrequired

    The subscription's id.

Query parameters

  • statusstringquery

    Only deliveries with this status.

    Allowed values:pendingdeliveredfailed

  • limitintegerquery

    Page size. Default 25, maximum 100.

  • offsetintegerquery

    How many results to skip before the first one returned. Maximum 10,000.

Responses

  • 200A page of deliveries
    Response fields
    • dataarray of WebhookDelivery
      • idstring · uuid
      • eventstring
      • statusstring

        Allowed values:pendingdeliveredfailed

      • attempt_countinteger
      • last_response_codeintegernullable
      • last_errorstringnullable
      • created_atstring · date-time
      • delivered_atstring · date-timenullable
    • totalinteger
  • 404Not found (not_found)
    Example response
    {
  "error": {
    "code": "not_found",
    "message": "Not found (`not_found`)."
  }
}