Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Headers

PayPathIQ-Event-Id
string<uuid>
required

Stable identity of the change; the same value as eventId.

PayPathIQ-Signature
string
required

t=,v1=[,v1=]

Body

application/json
clientCode
string
required

The Client whose resource changed.

Pattern: ^[A-Za-z0-9_-]{1,128}$
eventId
string<uuid>
required

Stable identity of the change, identical to the eventId in the change feed. Discard repeats.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
occurredAt
string<date-time>
required
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))$
resource
object
required
revision
integer
required

Accepted revision when the change committed. Notifications can arrive late or out of order: compare it with the revision you already hold.

Required range: 1 <= x <= 9007199254740991
type
enum<string>
required
Available options:
customer.created,
customer.updated,
receivable.created,
receivable.updated,
payment_request.created,
payment_request.updated,
reconciliation.created,
reconciliation.updated,
receipt_delivery.created,
receipt_delivery.updated,
payment_delivery.created

Response

2XX

Notification accepted. Any 2xx status.