Webhooks

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

Webhooks are used whenever something should happen automatically after a call, 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 transferring call summaries to a CRM, automatically creating support tickets after a call, or forwarding classifications and topics to analytics or reporting tools. Internal workflows can also be triggered this way, such as notifications to teams or creating tasks.

Prerequisites

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 call data will be sent automatically after a call is completed.

4

Optional additional settings can be configured, for example custom HTTP headers.

After saving, the changes are applied to all subsequent conversations of the agent.

How webhooks work

After a call is completed, sipgate AI Agents creates a call log. The call 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 flow 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 available immediately, without manual intervention.

Which data is transferred?

The webhook contains, among other things, metadata about the call, information about playbooks that were run, as well as 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

• 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 address:

217.116.118.254

This address should be stored 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.