For the complete documentation index, see llms.txt. This page is also available as Markdown.

How do I set up the sipgate AI Assist webhook?

Set up the AI Assist webhook in the sipgate desktop app to automatically send AI Assist results from a channel to external systems.

With the AI Assist Webhook, you can automatically send the AI Assist results of a channel – such as transcript, summary, to-dos and smart answers – to an external destination URL, for example to transfer them to a CRM or other tools with Zapier.

The AI Assist Webhook is to be distinguished from the CI Webhooks and the AI Assist Webhook is set up in the Desktop App and transmits the AI Assist results of a single channel. CI Webhooks, on the other hand, are configured in the App Web and transmit Conversation Intelligence data account-wide.

Prerequisites

  • The webhook can only be set up by administrators of the sipgate account.

  • It only applies to channels – so a channel with a phone number is required.

  • Currently, this feature is in beta status in the app and can be found under Labs in the settings, provided you are one of the beta testers. After the full release, the feature will be listed under AI Assist listed.

Where do I set up the webhook?

  1. As an admin, open the sipgate Desktop App.

  2. Open the section Labs ➔ AI Assist Webhook.

  3. Enter the desired destination URL.

  4. Select the desired data format: standard JSON or VCON.

  5. Save the setting.

After every call through a channel, the AI Assist results are automatically transferred as a bundle to the stored URL as soon as all content is available.

Payload format

Standard JSON contains, among other things, the following fields:

{
  "callHeadline": "...",
  "call": {
    "id": "...",
    "caller": "...",
    "callee": "...",
    "startTime": 0,
    "endTime": 0,
    "duration": 0,
    "direction": "inbound"
  },
  "channel": {
    "id": "...",
    "name": "..."
  },
  "transcriptions": [
    { "speaker": "caller", "startTime": 0, "endTime": 0, "text": "..." }
  ],
  "summary": "...",
  "actionItems": [{ "id": "...", "text": "..." }],
  "smallTalkItems": [{ "id": "...", "topic": "...", "description": "..." }],
  "smartAnswers": [{ "id": "...", "question": "...", "answer": "..." }]
}

Alternatively, the format VCON ("Virtualized Conversations") can be selected – a standard format for storing and sharing conversation data such as transcripts and recordings. More on this in the vCon specification.

You can find a practical application of the AI Assist Webhook with Zapier, HubSpot, Slack and Google Sheets in the article How do I use sipgate AI Assist in combination with HubSpot, Slack & Google Sheet?

Last updated