Skip to main content
WEBHOOK

Headers

webhook-id
string
required

The event id, evt_. It is the same on every try, so it is your dedupe key.

webhook-timestamp
string
required

The send time in seconds. Refuse a delivery older than five minutes.

webhook-signature
string
required

The HMAC-SHA256 signature of the id, the timestamp and the body, with the signing secret of the endpoint.

Body

application/json
id
string
required

The event id, evt_. It is the dedupe key of a consumer.

type
string
required

The event type, for example offer.created.

Allowed value: "ping"
sequence
integer
required

The position of the event in the feed of this side.

Required range: -9007199254740991 <= x <= 9007199254740991
occurred_at
string<date-time>
required

When the write that caused the event committed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
api_version
string
required

The contract version the data member is rendered at.

data
object
required

The snapshot of the resource this event is about. A seller-side event names deal_id and the id of its resource. A buyer block follows the BuyerStub shape, and its contact members ride only for a reader who holds the right. A delivery past the daily contact budget carries no contact members, and data.contact.status is budget_reached.

actor
object
required

Who caused the event.

Response

2XX

Your endpoint answers a 2xx status inside 15 seconds. Every other answer counts as a failed try.