Update webhook endpoint

Endpoint: PATCH /api/v1/webhooks/{id}

Availability: Live in production.

Authentication: API key in Authorization: Bearer <key> with the write scope.

Update a webhook endpoint's URL, events, or status. At least one field is required. Requires a plan with webhooks and an API key with write scope.

Parameters

• id (path, required): Webhook endpoint ID
• url (body): HTTPS URL that resolves to a public IP address
• events (body): Event types to subscribe to: compliance.acknowledged, * (all events)
• status (body): Setting active also resets the failure count

Example request

curl -X PATCH "https://backworkhealth.com/api/v1/webhooks/YOUR_ID" \
  -H "Authorization: Bearer $BACKWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example response (200)

{
  "success": true,
  "data": {
    "id": 0,
    "url": "string",
    "events": [
      "string"
    ],
    "status": "string",
    "failure_count": 0,
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}

curl -X PATCH "https://example.com/webhooks/0" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true,  "data": {    "id": 0,    "url": "string",    "events": [      "string"    ],    "status": "string",    "failure_count": 0,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "meta": {    "request_id": "string",    "timestamp": "2019-08-24T14:15:22Z"  }}

Last updated on