Update webhook subscription

This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.

Omitted keys are unchanged. Null filters or metadata clear them; null retryPolicy resets to defaults. Empty PATCH returns the current subscription. Queued deliveries retain their URL and retry-policy snapshot. Attempts processed while paused terminate as failed; resuming does not revive those failed deliveries.

Path parameters

subscription_idrequired
string
Subscription ID.

Name	Type	Description
subscription_idrequired	string	Subscription ID.

Body parameters

url · optional
string
Replace endpoint URL; absolute http(s), without credentials, with production HTTPS/public-host checks.
events · optional
array<string>
Replace with supported events/families; values are trimmed, lowercased, and deduplicated.
enabled · optional
boolean
Set true (active) or false (paused); null is coerced to false.
filters · optional
object
Replace filters; null clears to {}. Supports exact nested matches and conditions.
metadata · optional
object
Replace opaque metadata; null clears to {}.
retryPolicy · optional
object
Replace retry policy, not merge it. Omitted keys reset to defaults; values are clamped to create-endpoint bounds.

Name	Type	Description
url	string	Replace endpoint URL; absolute http(s), without credentials, with production HTTPS/public-host checks.
events	array<string>	Replace with supported events/families; values are trimmed, lowercased, and deduplicated.
enabled	boolean	Set true (active) or false (paused); null is coerced to false.
filters	object	Replace filters; null clears to {}. Supports exact nested matches and conditions.
metadata	object	Replace opaque metadata; null clears to {}.
retryPolicy	object	Replace retry policy, not merge it. Omitted keys reset to defaults; values are clamped to create-endpoint bounds.

Errors

Status	Meaning
400	Invalid patch payload.
401	Invalid API key or missing auth.
403	Missing webhooks:write scope.
404	Subscription not found.
422	Malformed body field types.

Example

bash

curl -X PATCH "https://app.autotouch.ai/api/webhook-subscriptions/67c88a24b4dd8f2d4999f912" \
    -H "Authorization: Bearer stk_your_key_id.your_secret" \
    -H "Content-Type: application/json" \
    -d '{"enabled":false}'

Request body

json

{
    "events": ["bulk_job.status_changed", "bulk_job.completed"],
    "retryPolicy": {
      "max_attempts": 5,
      "base_delay_seconds": 15,
      "max_delay_seconds": 600,
      "timeout_seconds": 10
    }
  }

Response example

json

{
    "success": true,
    "subscription": {
      "id": "67c88a24b4dd8f2d4999f912",
      "enabled": true,
      "events": ["bulk_job.status_changed", "bulk_job.completed"],
      "retry_policy": {
        "max_attempts": 5,
        "base_delay_seconds": 15,
        "max_delay_seconds": 600,
        "timeout_seconds": 10
      }
    }
  }