webhook.test

A test event, sent only when asked for (POST /v1/webhook-endpoints/{id}/test), whatever the endpoint subscribes to. Signed with the endpoint's secret (Standard Webhooks v1).

A test event, sent only when asked for (POST /v1/webhook-endpoints/{id}/test), whatever the endpoint subscribes to. Signed with the endpoint's secret (Standard Webhooks v1).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Globally unique event ID; the deduplication key

Match^evt_[0-9A-Za-z]{22}$

type*string

spec_version*string

Envelope version

source*string

Emitting module

Match^furniops\/[a-z][a-z0-9-]*$

subject*string

Aggregate ID; the ordering key

Length1 <= length

time*string

When the change was recorded (UTC)

Match

^(?:(?:\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))$

Formatdate-time

tenant_id*|

Owning organisation; null for shared-catalogue internal events

version*integer

Aggregate version after this change

Range1 <= value <= 9007199254740991

schema_version*integer

Version of this type's data schema

Range1 <= value <= 9007199254740991

correlation_id*|

The originating request, fetch or run

causation_id*|

The event that caused this one

livemode*boolean

False for test-mode data

data*

A test event's data

Response Body

Example Requests

POST/webhook.test

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200

Request Bodyapplication/json

Request Body

Response Body