Skip to main content
POST
/
webhooks
Create Webhook Endpoint
curl --request POST \
  --url http://localhost:8080/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "event_type": "<string>",
  "secret": "<string>",
  "description": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "url": "<string>",
  "event_type": "<string>",
  "is_active": true,
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_triggered_at": "2023-11-07T05:31:56Z",
  "failure_count": 123,
  "success_count": 123
}

Body

application/json
name
string
required
Required string length: 1 - 255
url
string
required
Minimum string length: 1
event_type
string
required
Required string length: 1 - 50
secret
string | null
Maximum string length: 128
description
string | null

Response

Successful Response

id
integer
required
name
string
required
url
string
required
event_type
string
required
is_active
boolean
required
description
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
last_triggered_at
string<date-time> | null
required
failure_count
integer
required
success_count
integer
required