Webhooks

Managing Webhooks

Create, test, and manage Converc webhook endpoints.

Quickstart

1.Create an API key in Settings → Integrations → API Keys.
2.Create a webhook endpoint with the events you want.
3.Verify signatures using your webhook secret.

Create a webhook endpoint

Use the API to register an endpoint that receives call events. If you omit events, the webhook receives every event type.

BASH

"color:#82aaff">curl "color:#c792ea">-X POST "https://api.converc.com/integrations/webhooks" \
  "color:#c792ea">-H "Authorization: Bearer <your-key-here>" \
  "color:#c792ea">-H "Content-Type: application/json" \
  "color:#c792ea">-d '{
    "url": "https://yourapp.com/webhooks",
    "events": ["call.ended", "call.recording_ready", "call.transcript_ready"]
  }'

Response:

JSON

{
  "webhook": {
    "id": "33333333-1111-1111-1111-222222222222",
    "url": "https://yourapp.com/webhooks",
    "events": ["call.ended", "call.recording_ready", "call.transcript_ready"],
    "isActive": true,
    "createdAt": "2024-01-01T00: 00: 0002",
    "updatedAt": "2024-01-01T00: 00: 0002"
  },
  "secret": "your-signing-secret"
}

Store the secret securely. It is used to verify webhook signatures and is only returned when the endpoint is created.

List webhook endpoints

BASH

"color:#82aaff">curl "color:#c792ea">-H "Authorization: Bearer <your-key-here>" \
  "https://api.converc.com/integrations/webhooks"

Response:

JSON

{
  "webhooks": [
    {
      "id": "33333333-1111-1111-1111-222222222222",
      "url": "https://yourapp.com/webhooks",
      "events": ["call.ended", "call.recording_ready"],
      "isActive": true,
      "createdAt": "2024-01-01T00: 00: 0002",
      "updatedAt": "2024-01-01T00: 00: 0002"
    }
  ]
}

Disable a webhook

BASH

"color:#82aaff">curl "color:#c792ea">-X DELETE \
  "color:#c792ea">-H "Authorization: Bearer <your-key-here>" \
  "https://api.converc.com/integrations/webhooks/33333333-1111-1111-1111-222222222222"

Response:

JSON

{
  "ok": true,
  "webhookId": "33333333-1111-1111-1111-222222222222",
  "isActive": false
}

Test a webhook

Send a test event from the API.

BASH

"color:#82aaff">curl "color:#c792ea">-X POST "https://api.converc.com/integrations/webhooks/test" \
  "color:#c792ea">-H "Authorization: Bearer <your-key-here>" \
  "color:#c792ea">-H "Content-Type: application/json" \
  "color:#c792ea">-d '{ "webhookId": "33333333-1111-1111-1111-222222222222" }'

Response:

JSON

{
  "ok": true,
  "status": 200,
  "error": null
}

The test payload uses the webhook.test event type.

Recent event samples (polling)

To fetch recent deliveries by event type:

BASH

"color:#82aaff">curl "color:#c792ea">-H "Authorization: Bearer <your-key-here>" \
  "https://api.converc.com/webhooks/events?eventType=call.ended&display=4"

Response:

JSON

[
  {
    "id": "event-uuid",
    "type": "call.event",
    "createdAt": "2024-01-01T00: 00: 0002",
    "organizationId": "org-uuid",
    "data": {}
  }
]

Helpful links

Open Integrations settings

Having issues? hello@converc.com.