Webhooks

An endpoint's delivery log

The deliveries made to this endpoint, newest first: product events, test sends and retries, each with what was sent and what the endpoint answered. Entries are kept for 30 days. An entry for a verification.* or job.* event holds that job's data, so it is removed with the job's results when the plan keeps results for less time than that, and can no longer be read or retried.

A scoped key sees only the entries whose payload it may read. Each entry holds its payload verbatim, so an entry is returned only when the key holds the scope that owns what its event carries (verification:read for verification.* and job.*, account:read for credits.*, deliverability:read for blacklist.detected and dmarc.failure; on an account that can have white-label sub-accounts, credits.* also needs white_label:read, because those events can name a sub-account). The events left out for that reason are named in withheld_events, and an unrestricted key or a dashboard session sees every entry. An id that belongs to another account is a 404.

get/v1/webhooks/{id}/logs

Request

  • Base URL: https://api.kawaa.com
  • URL: https://api.kawaa.com/v1/webhooks/{id}/logs
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.kawaa.com/oauth/authorize, token URL https://api.kawaa.com/oauth/token, scopes: webhooks:read)

Path parameters

idstring required

Query parameters

limitinteger

Entries per page. Default 20. A value above 100 is served as 100, and a missing, zero, negative or non-numeric value is served as 20, rather than refused; a fraction is rounded down. The response's limit says what was applied.

offsetinteger

Entries to skip from the newest, default 0. A value above 1,000 is served as 1,000 and a negative or non-numeric value as 0, rather than refused. Page past that with cursor. Not applied when cursor is sent.

cursorstring

The cursor from the previous page, to read the next one. Opaque; do not construct or edit one. A cursor that does not decode, is not in the shape this endpoint issues, or belongs to another webhook is a 400 with code INVALID_CURSOR; start again without it.

Response

One page of the log.

successunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.