Change a webhook

Changes the address, the event types or the description, or pauses or resumes it. Resuming sends what waited from the last 72 hours.

Needs a key with the webhooks:manage scope. Keys and scopes

Path parameters

• idstringrequired

  The webhook’s id.

  Starts with wh_.

Request body

• urlstring

  Up to 2,048 characters.

• eventsarray of any

  Replaces its event types. ["*"] for every type, including types BlueBot adds later; a list stops new types reaching it.

• descriptionstring or null

  Up to 200 characters.

• pausedboolean

  true pauses it; false resumes it and sends what waited from the last 72 hours.

Example

curl -X PATCH "https://usebluebot.com/api/v1/webhooks/wh_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paused": true
  }'

Response

200: The webhook after the change.

• idstringrequired

  A wh_ id.

  Starts with wh_.

• object"webhook"required
• urlstringrequired
• descriptionstring or nullrequired
• eventsarray of stringsrequired

  The event types it receives. For a webhook made with ["*"], every type there is now.

  One of message.queued, message.sent, message.delivered, message.read, message.failed, message.unconfirmed, message.expired, message.canceled, message.received, message.edited, message.unsent, reaction.added, reaction.removed, chat.created, contact.created, contact.stopped, contact.unstopped, sequence.completed, broadcast.completed, automation.matched, device.online, device.offline, device.check_failed.

• all_eventsbooleanrequired

  True when it was made with ["*"]: it also receives event types BlueBot adds later.

• api_versionstringrequired

  The payload version it was made with and keeps.

• statusstringrequired

  active; failing while deliveries fail (retried for about 3 days); paused by you, or after 72 hours with no successful answer.

  One of active, failing, paused.

• paused_attimestamp or nullrequired

  When it was paused.

• pause_reasonstring or nullrequired

  Who paused it: failing (72 hours of failures), customer or staff.

  One of failing, customer, staff.

• failing_sincetimestamp or nullrequired

  The first failure since the last success.

• last_success_attimestamp or nullrequired

  The last delivery answered with a 2xx.

• last_failure_attimestamp or nullrequired

  The last delivery that failed.

• last_statusinteger or nullrequired

  The HTTP status of the last answer.

• previous_secret_expires_attimestamp or nullrequired

  After a rotation, when the old secret stops signing alongside the new one.

• created_attimestamprequired

  When it was made.

{
  "id": "wh_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "webhook",
  "url": "https://hooks.zapier.com/hooks/standard/1234567/abcdef/",
  "description": "New replies to my CRM",
  "events": [
    "message.received",
    "message.failed"
  ],
  "all_events": false,
  "api_version": "2026-11-13",
  "status": "paused",
  "paused_at": "2026-11-13T19:41:00.000Z",
  "pause_reason": "customer",
  "failing_since": null,
  "last_success_at": "2026-11-13T19:44:13.000Z",
  "last_failure_at": null,
  "last_status": 200,
  "previous_secret_expires_at": null,
  "created_at": "2026-11-01T15:10:00.000Z"
}

Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

Try it