Skip to main content
POST
/
v1
/
webhooks
Register webhook
curl --request POST \
  --url https://api.framelane.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
url
string<uri>
required
Required string length: 1 - 2083
​
events
string[]
​
enabled
boolean
default:true

Response

Successful Response

Returned at create-time and after rotate-secret -- includes plaintext secret.

​
id
string
required
​
url
string
required
​
events
string[]
required
​
enabled
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
secret
string
required