webhooks

Update a webhook subscription

Update a subscription's url, subscribed events, or active flag.

Subscribable events: message.received, message.sent, message.delivered, message.read, message.failed, email.opened, email.clicked, email.bounced, email.complained, contact.created, contact.updated, suppression.created, suppression.removed, suppression.imported, flow.submitted, channel.connected, agent.run.completed, ticket.created, ticket.assigned, ticket.updated, ticket.reopened, ticket.resolved, commerce.order.paid, commerce.order.fulfilled, commerce.order.refunded, commerce.order.abandoned, table_row.created, table_row.status_changed.

suppression.created / suppression.removed fire on every do-not-contact change (STOP, unsubscribe, START resubscribe, dashboard or API add/remove) with { identifier, channel, message_type, reason, business_id, contact_id }.

suppression.imported fires ONCE per bulk opt-out import as a digest with { channel, message_type, reason, business_id, added, skipped, invalid, note }. Re-pull GET /api/v1/suppression to sync the individual rows.

Rotate a webhook secret: Issue a new signing secret for a webhook subscription. The new secret is returned once.

patch/api/v1/webhooks/{id}

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/webhooks/{id}
Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Request body

eventsstring[]

is_activeboolean

rotate_secretboolean

Example request

{
  "events": [
    "message.delivered"
  ],
  "is_active": true,
  "rotate_secret": true
}

Response

Success

request_idstring required

Example response

{
  "webhook": {
    "id": "9a342329-d651-4da0-a2d6-b24e4d3599b5",
    "url": "https://api.example.com/blueticked/events",
    "events": [
      "message.delivered"
    ],
    "is_active": true
  },
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.