Webhooks

The webhook object

What every call below returns, field by field.

objectalways list

datalist of objects

Show its fields

objectalways event_type

nametext

What event_type says on a webhook and on each delivery.

descriptiontext

has_moretrue or false

Whether another page follows this one.

next_cursortext

Pass as cursor for the next page. Null on the last page.

suppressedinteger

Rows that matched and were withheld, for example for a missing entitlement. Never silently zero: a withheld row is a fact about the answer.

totalobject

Only when total=true was asked for, and only on the first page.

Show its fields

valueinteger

relationone of eq, gte

'eq' is exact. 'gte' means there are at least this many; the count was capped.