Webhooks

LiveSwitch provides Webhooks to allow you to be notified when users perform certain actions in LiveSwitch Contact and Concierge.

Webhooks must be created programatically using the Webhooks API. Please note that for a user to manage Webhooks, they must have admin rights, because Webhooks (currently) fire for changes made by any user within a single organization.

Webhooks can currently be created for two primary entities: the "Conversation" and the "Contact". The events for both include "Create", "Update", and "Delete". Not all events contain all details of a given entity; if you are uncertain, the ID of the entity is ALWAYS included in the event details, as well as in the x-liveswitch-entity-id field, and you can always request the full record via the GET endpoint for that entity.

Additionally, the following headers will be provided in the event:

"x-liveswitch-transaction-id": the ID of the underlying transaction that triggered the event. Globally unique.
"x-liveswitch-entity-id": the ID of the entity that was modified or created or deleted
"x-liveswitch-webhook-id": the ID of the webhook that is being invoked
"x-liveswitch-webhook-event-type": CREATE, UPDATE, or DELETE
"x-liveswitch-webhook-entity-name": the underlying entity name, lowercase, either "contact" or "conversation"