POST
/
webhooks
curl --request POST \
  --url https://core.api.ravennahq.com/api/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "active": true,
  "eventTypes": [
    "Ticket",
    "Message"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "active": true,
  "eventTypes": [
    "Ticket"
  ],
  "workspaceId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Body

application/json
url
string
required
name
string
secret
string
active
boolean
default:true
eventTypes
enum<string>[]

Response

200
application/json

Successful response

id
string
required
name
string | null
required
url
string
required
secret
string | null
required
active
boolean
required
eventTypes
enum<string>[]
required
workspaceId
string
required
createdAt
string
required
updatedAt
string
required