Managing Kixie Event Webhooks via API

Introduction

This article guides you through using Kixie’s APIs to manage webhooks. These APIs facilitate creating, updating, and retrieving webhooks.

API Overview

• Create Webhook: Sets up new webhooks.
• Update Webhook: Modifies existing webhooks.
• Get All Webhooks: Retrieves all webhooks for an account.
• Delete Webhook: Deletes existing webhooks.

Authorization

Before using these APIs, you'll need your businessid and apikey. You can find these in the Kixie dashboard by navigating to Manage > Account Settings > Integrations.

1. Create Webhook API

This API allows you to set up various types of webhooks.

Endpoint

POST: https://apig.kixie.com/app/v1/api/postwebhook

Payload Example

{
"apikey": "your-api-key",
"businessid": your-business-id,
"call": "postWebhook",
"callresult": "all",
"direction": "all",
"disposition": "all",
"eventname": "endcall",
"headers": false,
"location": "your-webhook-url",
"name": "webhook-name",
"runtime": "realtime"
}

Event Types

• endcall
• startcall
• answeredcall
• SMS
• disposition
• voicemail
• scheduledactivity
• cisummary

Including Headers

• To include headers, provide them as a JSON array: "headers": "[{\"name\":\"header1\",\"value\":\"header1value\"}, ...]"
• If there are no headers, simply use "headers": "false" without quotes as shown in the above example.

"Endcall" Event - "Direction" Values

• all
• incoming
• outgoing

"Endcall" Event - "Call Result" Values

• all
• answered
• missed

2. Update Webhook API

This API lets you modify existing webhook settings.

Endpoint

POST: https://apig.kixie.com/app/v1/api/postwebhook

Payload Example

{
"apikey": "your-api-key",
"businessid": your-business-id,
"call": "putWebhook",
"callresult": "all",
"direction": "all",
"disposition": "all",
"eventname": "endcall",
"headers": false,
"location": "your-webhook-url",
"name": "new-webhook-name",
"runtime": "realtime",
"webhookid": "your-webhook-id"
}

3. Get All Webhooks API

Retrieve a list of all associated webhooks.

Endpoint

POST: https://apig.kixie.com/app/v1/api/getWebhooks

Payload Example

{
"apikey": "your-api-key",
"businessid": your-business-id,
"call": "getWebhooks"
}

4. Delete Webhook API

Removes an existing webhook.

Endpoint

POST: https://apig.kixie.com/app/v1/api/deleteWebhooks

Payload Example

{
"apikey": "your-api-key",
"businessid": your-business-id,
"call": "removeWebhook",
"webhookid": your-webhook-id
}

With these APIs, you can manage your Kixie webhooks for various tracking needs, such as calls and SMS activities.

How to Get Support

Please email support@kixie.com or chat us live via the Kixie Dashboard for ongoing support.