Skip to content

Add a webhook (admin); the secret is returned once

POST
/webhooks
curl --request POST \
--url http://localhost:8100/api/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "url": "https://example.com", "events": [ "issue.created" ], "project": "example", "secret": "example" }'
Media typeapplication/json
object
url
required
string format: uri
events
required
Array<string>
Allowed values: issue.created issue.updated issue.deleted comment.created
project

Limit to one project key

string
secret
string
>= 16 characters <= 80 characters

Created

Media typeapplication/json
object
data
object
id
integer
url
string format: uri
events
Array<string>
project
string | null
active
boolean
last_status
integer | null
last_delivered_at
string | null format: date-time
secret
string

Example generated

{
"data": {
"id": 1,
"url": "https://example.com",
"events": [
"example"
],
"project": "example",
"active": true,
"last_status": 1,
"last_delivered_at": "2026-04-15T12:00:00Z",
"secret": "example"
}
}