Docs/Support/API/Webhooks

Webhooks API

Register HTTP webhook endpoints to receive real-time notifications for ticket lifecycles, SLA breaches, message replies, and agent assignments with HMAC-SHA256 signatures.

HMAC-SHA256 Signatures: Every outbound webhook request contains a header X-Vyntech-Signature: t=1724037500,v1=... generated using your subscription signing secret to prevent tampering and replay attacks.

Fetches all active webhook subscriptions configured for the Support Desk product in this tenant.

List WebhooksAuth

Fetch all webhook subscription endpoints registered for the support product in this tenant.

Status Codes

Name
200
Type
HTTP
Description
Webhook list returned successfully
Name
403
Type
HTTP
Description
Forbidden - requires Admin role

Request

GET/v1/support/webhooks

Response 200

Creates a new webhook listener (Admin only). The returned signing secret is used to verify incoming webhook payloads using HMAC-SHA256.

Create Webhook SubscriptionAuth

Payload Example

{
  "url": "https://api.acme-corp.com/vyntech/support-events",
  "events": [
    "ticket.created",
    "ticket.status_changed",
    "ticket.sla_breached"
  ],
  "secret": "whsec_3fa85f6457174562b3fc2c963f66afa6"
}

Status Codes

Name
201
Type
HTTP
Description
Webhook subscription registered successfully
Name
400
Type
HTTP
Description
Invalid URL or unknown event topics
Name
403
Type
HTTP
Description
Forbidden - requires Admin role

Request Parameters

Name
url
Type
string
Required
Example
eg. https://api.acme.com/webhooks
Description
HTTPS URL endpoint where events will be delivered via POST.
Name
events
Type
string[]
Required
Description
Array of event topic names: ticket.created, ticket.status_changed, ticket.sla_breached, ticket.message_created, ticket.assigned.
Name
secret
Type
string
Description
Optional custom HMAC signing secret (auto-generated if omitted).

Request

POST/v1/support/webhooks

Response 201

Updates delivery URL, subscribed event topics, or active status.

Update WebhookAuth

Update webhook subscription settings.

Payload Example

{
  "events": ["ticket.created", "ticket.status_changed", "ticket.sla_breached"],
  "is_active": true
}

Status Codes

Name
200
Type
HTTP
Description
Webhook subscription updated successfully
Name
404
Type
HTTP
Description
Webhook not found

Request

PUT/v1/support/webhooks/{id}

Response 200

Deletes a webhook subscription and stops event delivery.

Delete WebhookAuth

Remove a webhook endpoint.

Status Codes

Name
200
Type
HTTP
Description
Webhook subscription deleted
Name
404
Type
HTTP
Description
Webhook not found

Request

DELETE/v1/support/webhooks/{id}

Response 200