Webhooks

Subscriptions

A subscription pairs a trigger with a target URL. Each delivery is signed with the subscription's signing_secret, which is returned only once when the subscription is created. See the webhooks overview for payload shape and signature verification.

POST/v1/subscriptions

Create a subscription

Registers a new webhook subscription. The response includes a signing_secret you must store, it is only ever returned at creation time and is required to verify each incoming payload.

Body parameters

NameTypeDescription
trigger_idrequiredstringThe event to subscribe to. See available triggers.
target_urlrequiredstringAbsolute https URL Coastline will POST to. http URLs are accepted but discouraged.

Returns

HTTP 201 Created with the subscription record, including the one-time signing_secret.

GET/v1/subscriptions

List subscriptions

Returns all active (non-revoked) subscriptions for the workspace, ordered by most recently created first. The signing_secret is never returned by this endpoint.

DELETE/v1/subscriptions/{id}

Revoke a subscription

Permanently revokes a subscription so no further deliveries will be sent. Returns HTTP 204 No Content on success. Already-revoked subscriptions also return 204.