Create Post Call Webhook

Create and send post call webhooks for specified calls.

POST /v1/postcall/webhooks/create

Create Post Call Webhook

cURL

curl --request POST \
  --url https://api.bland.ai/v1/postcall/webhooks/create \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "call_ids": [
    "<string>"
  ],
  "webhook_url": "<string>"
}
'

200

{
  "data": [
    {
      "call_id": "<string>",
      "payload": {},
      "url": "<string>",
      "user_id": "<string>",
      "created_at": "<string>",
      "metadata": [
        {
          "sent_at": "<string>",
          "response_code": 123,
          "response_time": "<string>",
          "send_type": "<string>"
        }
      ]
    }
  ],
  "errors": [
    {
      "error": "<string>",
      "message": "<string>"
    }
  ]
}

Overview

Create and send post call webhooks for one or more call IDs. This endpoint allows you to create webhooks for calls that don’t already have webhooks configured. The webhooks will be sent immediately after creation to the specified webhook URL. If the call has already sent a post call webhook, this endpoint will return an error.

---

Headers

authorization · string · required

Your API key for authentication.

---

Body Parameters

call_ids · string[] · required

Array of call IDs to create and send webhooks for. Each call ID must be unique within the array.

Show Array Item Properties

call_id · string

The unique identifier of a call to create a webhook for.

webhook_url · string · required

The URL where the webhook payloads should be sent.

---

Response

data · array

Array of webhook objects for each created webhook.

Show Array Item Properties

call_id · string

The unique identifier of the call this webhook is for.

payload · object

The webhook payload data that was sent.

url · string

The URL the webhook was sent to.

user_id · string

The ID of the user/org that owns this webhook.

created_at · string

Timestamp of when the webhook was created.

metadata · array

Array of metadata objects about webhook send attempts.

Show Array Item Properties

sent_at · string

Timestamp of when this webhook attempt was sent.

response_code · integer

HTTP response code received from the webhook endpoint.

response_time · string

Time taken to receive a response from the webhook endpoint.

send_type · string

How this webhook was triggered (will be “create” in this case).

errors · array

Array of error objects if any errors occurred.

Show Array Item Properties

error · string

The error code. Possible values:

• “invalid_parameter”: Invalid request parameters
• “INTERNAL_SERVER_ERROR”: Server error occurred

message · string

Detailed error message.