Webhooks - G-Tateth API Documentation

Manage webhooks to receive real-time event notifications from your G-Tateth account.

Create Webhook

body

required

Name for the webhook (1-100 characters)

body

required

HTTPS URL where webhook events will be sent

body

required

Array of event types to subscribe to (e.g., ["conversation.created", "customer.updated"])

body

Custom headers to include with webhook requests (object)

body

Retry policy configuration:

{
  "maxRetries": 3,
  "backoffStrategy": "exponential"
}

maxRetries: Number of retry attempts (0-10)
backoffStrategy: "linear" or "exponential"

boolean

true

string

Webhook ID

string

Webhook name

string

Webhook URL

array

Array of subscribed events

string

Webhook secret for signature verification (only shown once)

boolean

Whether the webhook is active

Save the webhook secret immediately - it’s only shown once and is required for signature verification!

Example Request

curl -X POST https://api.g-tateth.com/api/v1/webhooks \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Webhook",
    "url": "https://myapp.com/webhooks/g-tateth",
    "events": ["conversation.created", "conversation.updated", "customer.created"],
    "retryPolicy": {
      "maxRetries": 3,
      "backoffStrategy": "exponential"
    }
  }'

List Webhooks

boolean

Filter by active status: true or false

integer

Page number (default: 1)

integer

Items per page (default: 20, max: 100)

boolean

true

array

Array of webhook objects

number

Total number of webhooks

number

Current page number

number

Items per page

number

Total number of pages

Get Webhook

string

required

Webhook ID

boolean

true

object

Webhook object (secret is not included)

Update Webhook

string

required

Webhook ID

body

Update webhook name (1-100 characters)

body

Update webhook URL (must be HTTPS)

body

Update array of subscribed events

body

Activate or deactivate the webhook

body

Update custom headers

body

Update retry policy

boolean

true

object

Updated webhook object

Delete Webhook

string

required

Webhook ID

boolean

true

string

Success message

This action cannot be undone! The webhook will stop receiving events immediately.

Test Webhook

string

required

Webhook ID

boolean

true

string

“Test webhook event sent”

This sends a test event to your webhook URL. Use this to verify your webhook endpoint is working correctly.

Get Webhook Logs

string

required

Webhook ID

string

Filter by delivery status: pending, success, failed

integer

Page number (default: 1)

integer

Items per page (default: 20, max: 100)

boolean

true

array

Array of delivery log objects

number

Total number of logs

number

Current page number

number

Items per page

number

Total number of pages

Log Object Structure

{
  "_id": "...",
  "webhookId": "...",
  "event": "conversation.created",
  "status": "success",
  "statusCode": 200,
  "attempt": 1,
  "deliveredAt": "2024-01-01T12:00:00Z",
  "responseTime": 150,
  "error": null
}

Supported Events

Conversation Events

conversation.created - New conversation created
conversation.updated - Conversation updated
conversation.assigned - Conversation assigned to agent
conversation.closed - Conversation closed

Customer Events

customer.created - New customer created
customer.updated - Customer updated

Message Events

message.sent - Message sent
message.received - Message received

Call Events

call.initiated - Call has been initiated
call.answered - Call has been answered
call.completed - Call has completed
call.recording.available - Call recording is available

Required Permissions

webhook:manage - Required for all webhook operations

Webhook Signature Verification

Each webhook request includes an X-Webhook-Signature header. Always verify signatures to ensure requests are from G-Tateth. See the Webhooks Guide for signature verification examples in various languages.

​Create Webhook

​Example Request

​List Webhooks

​Get Webhook

​Update Webhook

​Delete Webhook

​Test Webhook

​Get Webhook Logs

​Log Object Structure

​Supported Events

​Conversation Events

​Customer Events

​Message Events

​Call Events

​Required Permissions

​Webhook Signature Verification

Create Webhook

Example Request

List Webhooks

Get Webhook

Update Webhook

Delete Webhook

Test Webhook

Get Webhook Logs

Log Object Structure

Supported Events

Conversation Events

Customer Events

Message Events

Call Events

Required Permissions

Webhook Signature Verification