Webhooks

Managing Webhooks

Create, test, and manage Converc webhook endpoints. Webhooks are available on the Pro and Scale plans.

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. You can register up to 10 endpoints per organization.

BASH

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

Response:

JSON

{
  "webhook": {
    "id": "33333333-1111-1111-1111-222222222222",
    "url": "https://yourapp.com/converc/webhook",
    "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

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

Response:

JSON

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

Disable a webhook

BASH

curl -X DELETE \
  -H "Authorization: Bearer <your-key-here>" \
  "https://converc.com/api/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

curl -X POST "https://converc.com/api/integrations/webhooks/test" \
  -H "Authorization: Bearer <your-key-here>" \
  -H "Content-Type: application/json" \
  -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

curl -H "Authorization: Bearer <your-key-here>" \
  "https://converc.com/api/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.