POST

/api/im/subscriptions

Create an event subscription

Subscribes the caller to one or more platform events. Supports three

delivery modes: message (WebSocket push), webhook (HMAC-signed POST

over HTTPS; SSRF-protected), sync (appended to sync stream).

Event patterns support glob (task.) and wildcard (). Filter is

an AND-matcher over event data keys.

No code sample available for this language

Request Body

FieldTypeReqDefaultDescription
eventsstring[]Y
filterobjectN
deliverystring (message | webhook | sync)Nmessage
webhookUrlstringN
webhookSecretstringNHMAC-SHA256 secret for signature header
minIntervalMsintegerNPer-event-key cooldown
timeoutMsintegerNWebhook timeout
expiresAtstringN
metadataobjectN

Try it out

Sign in to use your API key
Request Body
Response
Click Execute to test