Webhooks

Server event subscriptions

bg-dots
bg-dots

The System → Webhooks section is used to configure subscribers for server events and to view the log of sent notifications.

Subscribers and events

Contains subscriber and recent-event tables and service controls.

  • “New webhook” – opens the dialog to add a subscriber.
  • “Restart service” – restarts the webhook service.
  • “Purge events older than a day” – deletes event log records older than one day.

Webhook subscribers

  • “URL” – subscriber callback address.
  • “Last sent event” – type and time of the last sent event.
  • “Average ping” – average subscriber response time.
  • “Success rate” – number of successful deliveries.
  • “Error rate” – number of delivery errors.
  • “Total sent” – total number of sent notifications.
  • “Actions” – edit and delete controls for the subscriber.

Recent events

  • “#” – event sequence number.
  • “Timestamp” – event date and time.
  • “Type” – event type.
  • “Payload” – event body.

New webhook

Opened by the “New webhook” button. The “Add a new webhook subscriber” dialog contains parameters of the new subscriber.

  • “Callback URL” – URL that receives event notifications. HTTP and HTTPS URLs are allowed.
  • “Authorization type” – authorization method for requests to the subscriber. Available values: None, HTTP Basic, Bearer token. Default: None.
  • “Subscribe to events” – event types to subscribe to; selected with checkboxes. Available groups: *, account.*, account.created, account.updated, account.deleted, conference.*, conference.created, conference.updated, conference.deleted, conference.started, conference.stopped, conference.presentation.started, conference.presentation.stopped, conference.recording.started, conference.recording.stopped, participant.*, participant.added.multiple, participant.removed.multiple, participant.connected, participant.disconnected, recording.*, recording.completed, SBC.*, SBC.setting.changed.
  • “Cancel” – returns to the list without saving.
  • “Add” – creates the subscriber.
Email Oauth 2.0