Register an https endpoint. The signing secret is returned once

post/webhooks/endpoints

Before you call

Credential: Authorization: Bearer $KEY
Scope: keys:admin
Sdk: keys.webhook.create
Cli: keys webhook create

Request bodyapplication/json, required

testboolean
urlstring (uri)required
At most 500 characters.
eventslist of string
descriptionstring
At most 200 characters.

Responses

201application/json
Success
- idstring (uuid)required
- testDeliverybooleanrequired
- urlstringrequired
- descriptionstringrequired
- eventslist of stringrequired
- failuresnumberrequired
- disabledAtstring or nullrequired
- createdBystringrequired
- createdAtstringrequired
- secretstringrequired
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/webhooks/endpoints' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown