Skip to content

Configure support webhooks

Webhooks notify an integration about selected support knowledge events. They do not grant the receiver access to article bodies.

Create an endpoint

  1. Create an active KB API client with kb.webhooks and the reading scopes needed for the intended events.
  2. Open Configuration > Support AI > Webhooks.
  3. Enter the HTTPS endpoint URL and choose the client that owns it.
  4. Select the events the receiver needs.
  5. Choose Active or Disabled and create the endpoint.
  6. Save the displayed signing secret securely in the receiving service.

A disabled endpoint does not send deliveries. The owner client's current permissions limit which events can be delivered. Changing the client can affect future event eligibility.

Build the receiver

Verify the signature using the documented shared webhook contract. Handle repeated event IDs safely. Record the event before acknowledging it. Retrieve any needed article through the scoped API and recheck access there.

Review delivery

Open Deliveries for the endpoint. Read the status before replaying. A replay sends the event again, so the receiver must handle duplicates. Endpoint acceptance is not proof that a downstream business workflow completed.

Rotate a signing secret

Choose Rotate signing secret and confirm the change. Update the receiver securely. The previous secret remains available for the documented overlap period. Never copy a real signing secret into a Help page or customer ticket.

Use the webhook reference for event names, payloads, signature headers and delivery behavior.