Webhooks

Update a webhook

Write requests are disabled on production docs to avoid account noise. Fill the request below, then copy the generated cURL, fetch, or JSON output.

Copy page

Update an existing webhook's topic, URL, or metadata.

PUT /api/v2/webhooks/{webhook_id}

Authorisation

Bearer token required. Include in the Authorization header.

Path parameters

webhook_id string path required

The ID of the webhook.

Example: 1

Request body

topic string body

url string body

meta array body

Request body example

{
  "topic": "product:created",
  "url": "https://example.com/webhook",
  "meta": []
}

Update a webhook

curl https://web.signcustomiser.com/api/v2/webhooks/1 \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "product:created",
  "url": "https://example.com/webhook",
  "meta": []
}'

{
  "webhook": {
    "webhook_id": 1,
    "topic": "order:created",
    "url": "https://example.com/webhook-updated",
    "status": "active",
    "secret": "abc123...",
    "meta": {},
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-02T00:00:00.000000Z"
  }
}