Skip to main content
POST
/
v1
/
platforms
/
me
/
webhooks
Create webhook endpoint
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', description: '<string>', secret: '<string>', events: ['*']})
};

fetch('https://api.keystoneos.xyz/v1/platforms/me/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Body

application/json
url
string
required
description
string | null
secret
string | null
events
string[]

Response

Successful Response

Response for endpoint creation - includes the secret (only returned once).

id
string<uuid>
required
url
string
required
description
string | null
required
events
string[]
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
secret
string
required