Create webhook

Create a new webhook. The secret is stored encrypted and is never returned by the API - only its presence is exposed via has_secret.

POST /v1/webhooks

Create webhook

cURL

curl --request POST \
  --url http://localhost:8080/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "timeout": 60,
  "retry_attempts": 5,
  "verify_ssl": true,
  "is_active": true
}
'

201

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "method": "<string>",
    "has_secret": true,
    "headers": {},
    "timeout": 123,
    "retry_attempts": 123,
    "verify_ssl": true,
    "is_active": true,
    "last_fired_at": "<string>",
    "created_at": "<string>"
  },
  "success": true,
  "code": 201,
  "message": "Webhook created successfully."
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Maximum string length: 100

url · string<uri> · required

Maximum string length: 500

method · enum<string> · required

Available options: POST, GET, PUT, PATCH

secret · string | null

Maximum string length: 500

headers · object[] | null

Hide child attributes

headers. key · string

Maximum string length: 100

headers. value · string

Maximum string length: 500

timeout · integer

Required range: 1 <= x <= 120

retry_attempts · integer

Required range: 0 <= x <= 10

verify_ssl · boolean

is_active · boolean

Response

201

application/json

WebhookResource

data · WebhookResource · object · required

Hide child attributes

data. id · string · required

data. name · string · required

data. url · string · required

data. method · string · required

data. has_secret · boolean · required

data. headers · object · required

Hide child attributes

data.headers. {key} · string

data. timeout · integer · required

data. retry_attempts · integer · required

data. verify_ssl · boolean · required

data. is_active · boolean · required

data. last_fired_at · string | null · required

data. created_at · string · required

success · boolean · required

code · integer · required

message · string · required

Allowed value: "Webhook created successfully."