Skip to main content
POST
/
webhooks
Create webhook
curl --request POST \
  --url https://api.spikelabs.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "conversation.started"
  ]
}
'
{
  "id": "wh_abc123",
  "object": "webhook",
  "url": "<string>",
  "events": [
    "conversation.started"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "enabled": true
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use your secret key (starts with sk_) as a Bearer token.

Body

application/json
​
url
string<uri>
required
​
events
enum<string>[]
required
Available options:
conversation.started,
conversation.ended,
video.completed,
video.failed,
knowledge.processed,
memory.created

Response

Webhook created

​
id
string
required
Example:

"wh_abc123"

​
object
enum<string>
required
Available options:
webhook
​
url
string<uri>
required
​
events
enum<string>[]
required
Available options:
conversation.started,
conversation.ended,
video.completed,
video.failed,
knowledge.processed,
memory.created
​
created_at
string<date-time>
required
​
secret
string

Signing secret (only on create)

​
enabled
boolean
default:true