Webhooks

With webhooks, conversation data from sipgate AI Agents can be automatically forwarded to external systems. This means information from calls can be incorporated directly into existing processes, such as a CRM, a ticketing system, or internal reporting.

Webhooks are used whenever something should happen automatically after a conversation, without data having to be transferred manually.

Note: For more complex integrations, we support you as part of our Enterprise offering. Schedule an appointment for custom integrations, to discuss suitable solutions together.

What are webhooks used for?

Typical use cases include passing conversation summaries to a CRM, automatically creating support tickets after a call, or forwarding classifications and topics to analysis or reporting tools. Internal workflows can also be triggered this way, such as notifications to teams or the creation of tasks.

Requirements

To use webhooks, you need a target URL to which the data should be sent. The receiving system must be able to process HTTP POST requests with a JSON payload.

Set up webhooks

1

Open your account management.

2

Go to AI Agents, select the desired agent or create a new one. In the agent's user interface, you will find the navigation item Webhooks.

3

Store one or more webhook URLs there to which conversation data is automatically sent after a call has ended.

4

Optionally, additional settings can be made, for example custom HTTP headers.

The changes are applied to all subsequent conversations of the agent after saving.

How webhooks work

After a call ends, sipgate AI Agents creates a call log. The conversation data is then automatically sent via HTTP POST to the stored webhook URL. The data is transmitted as a JSON payload and can be stored or further processed in the target system.

A typical process looks like this: a call ends, the conversation is summarized, and the information is forwarded directly to a connected system. Your team has the relevant data immediately available, without manual intervention.

What data is transmitted?

The webhook contains, among other things, metadata about the call, information about completed playbooks, and a summary of the conversation including recognized topics. A shortened example of a payload looks like this:

ResposeType

type WebhookPayload = {
  version: "v1" | "v2";
  call: {
    id: string;
    from: string;               // Phone number with "+" prefix, e.g. "[phone]"
    to: string;                 // Phone number with "+" prefix, e.g. "[phone]"
    startTime: number;          // Epoch milliseconds
    endTime: number;            // Epoch milliseconds
    duration: number;           // Duration in seconds
    direction: "in" | "out";
    users: {
      userId: string;
      accountId: string;
      fullUserId: string;
      firstName: string;
      lastName: string;
      fullName: string;
    }[];
  };
  assist?: {
    summary?: {
      content: string;
      keyPoints: string[];
      topics: string[];
    };
    callScenarios?: {
      name: string;
      smartAnswers: {
        setName: string;
        setItems: {
          question: string;
          answer: string;
          title?: string;
        }[];
      }[];
    }[];
    transcription?: {
      content: string;          // Full transcription as text
      chunks: {
        speaker: "caller" | "callee";
        startTime: number;      // Epoch milliseconds
        endTime: number;        // Epoch milliseconds
        content: string;
      }[];
    };
  };
};

Example-JSON

Optional fields

• assist.summary | Only present if a summary was created
• assist.callScenarios | Only present if playbooks were run through
• assist.transcription | Only present if transcript storage is enabled

The complete payload can additionally contain information from playbooks, such as captured answers or classifications.

Security

To ensure that only requests from sipgate AI Agents are processed, the source IP address of incoming webhook requests should be checked. The requests come from the following IP addresses:

• 217.116.118.254
• 212.9.46.32

This address should be entered in the allow list of the receiving system to prevent unauthorized access.

Classification

Webhooks provide the basis for automation, but do not perform any processing themselves. What happens to the sent data is defined in the respective target system. In combination with playbooks, call logs, and analyses, end-to-end automated workflows can be built.