SEsentdm
Webhooks

Get webhook events

Changed on

Retrieves a paginated list of delivery events for the specified webhook, newest first. If the webhook is cloned onto your sender profiles (version 1) or inheritable by them (version 2, is_inheritable), the list includes their events; read payload.account_id to tell whose event it is. A sender profile may read its organization's inheritable webhook too, and gets the events about itself.

get/v3/webhooks/{id}/events

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/webhooks/{id}/events
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring uuid required

Query parameters

pageinteger required
page_sizeinteger required
searchstring nullable

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Response

Webhook events retrieved successfully

successboolean

Indicates whether the request was successful

Changes

  • 41acb2ceb84dRevision changes
    • info

      added the non-success 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

  • 3eaea6f4015aRevision changes
    • info

      added the optional property ///////////////// to the response with the status