Webhook API Reference

Activate Webhook

Activate a webhook endpoint.

Resumes deliveries for a paused endpoint. When automatic delivery stopped after repeated failures, this requests a recovery attempt straight away. Activating an active endpoint changes nothing. Events that happened while the endpoint was paused are not sent.

POST
/shipos/webhooks/{webhook_id}/activate
x-access-token<token>

In: header

Path Parameters

webhook_id*string

ID of the webhook endpoint

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/shipos/webhooks/string/activate"
{  "recovery_requested": true}