Skip to content
Website BuddyWebsite BuddyWebsite builder
Sign inGet started
API reference/Webhooks

Change a webhook

Try it

Changes the address, the events, the site filter (site_id; null = every site) or the note; paused=true stops sending (events are not queued while paused), paused=false resumes and clears the failure count.

PATCH/api/v1/webhooks/{webhook_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the webhooks:manage scope — add, change and delete webhooks.

webhooks:manageChanges the draft or a recordIdempotency-Key optionalMCP tool: update_webhook

Parameters

Named placeholders go in the path; the rest in a JSON body.

webhook_idstringPath · required
The webhook's id.1 to 100 characters
urlstringBody · optional
8 to 500 characters
eventsarray of stringBody · optional
Which events to send: form_message.created (A visitor sent a form message), site_order.created (A client site's store took an order), donation.received (A client site received a gift), appointment.created (A visitor booked a time), appointment.changed (A booking was confirmed, declined, cancelled or moved), member.requested (A visitor asked to become a member), content_request.answered (A client sent the content you asked for), site.changes_sent (A client finished changes and sent them to you), site.published (A site was published), shop_order.created (Someone ordered a website from your shop).
descriptionstring | nullBody · optional
At most 120 characters
pausedbooleanBody · optional
site_idstring | nullBody · optional
Only this site's events (one of your site ids). Leave it out or send null for every site; an endpoint narrowed to a site never hears shop_order.created.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X PATCH 'https://websites.workflowcorp.com/api/v1/webhooks/WEBHOOK_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"paused":true}'
Example arguments
{
  "webhook_id": "WEBHOOK_ID",
  "paused": true
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "site": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "The one site whose events it hears; null = every site (and your shop orders)."
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "secret_prefix": {
      "type": "string",
      "description": "The first characters of the signing secret, to tell secrets apart."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ]
    },
    "paused_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "failures_in_a_row": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "last_success_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "last_failure_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "is_sample": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "url",
    "events",
    "site",
    "description",
    "secret_prefix",
    "status",
    "paused_reason",
    "failures_in_a_row",
    "last_success_at",
    "last_failure_at",
    "is_sample",
    "created_at"
  ],
  "additionalProperties": false
}