Skip to main content
POST
Create Webhook
Register a webhook URL to receive radar and/or signal events as they occur. Shoal will POST a JSON payload to your URL whenever a matching event is detected.
Webhook creation is available only on plans that include webhook access.

Request Body

Request

cURL
Python
JavaScript

Response (201)

Save the secret from the response — it is only returned once at creation time. You’ll need it to verify webhook signatures. See Webhook Signatures.

Errors