Skip to main content
POST
/
api
/
v1
/
webhooks
/
endpoints
Create webhook endpoint with events
curl --request POST \
  --url https://dev-chat-engine.actualize.ae/api/v1/webhooks/endpoints \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "url": "http://example.com",
  "eventNames": [
    "<string>"
  ],
  "appId": "app_2p6o53fSwMzTJNvOmivgXBr26wS",
  "description": "Purpose of webhook",
  "rateLimit": 123,
  "metadata": {},
  "secret": "<string>"
}
'

Headers

​
x-api-key
string
required

Body

application/json
​
url
string
required

The URL to which the webhook will send data

Example:

"http://example.com"

​
eventNames
string[]
required

The event type for the webhook

​
appId
string
required

App id

Example:

"app_2p6o53fSwMzTJNvOmivgXBr26wS"

​
description
string
required

Endpoint description

Example:

"Purpose of webhook"

​
rateLimit
number

Rate limit for the endpoint

​
metadata
object

Metadata for the endpoint

​
secret
string

Secret for the endpoint

Response

201

The endpoint has been successfully created.