Platform webhooks

GET/v1/platform-webhooks

Authorization

bearer

Response

200

Body

application/json

id*string

url*string

isActive*boolean

events*array of string

createdAtstring (date-time)

lastUpdatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/v1/platform-webhooks', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Bearer"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "url": "text",
    "isActive": false,
    "events": [
      "text"
    ],
    "createdAt": "2024-12-12T02:37:42.832Z",
    "lastUpdatedAt": "2024-12-12T02:37:42.832Z"
  }
]

POST/v1/platform-webhooks

Authorization

bearer

Body

application/json

url*string

events*array of string

secretstring

Response

201

Request

JavaScriptCurlPython

const response = await fetch('/v1/platform-webhooks', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Bearer",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text",
      "events": [
        "text"
      ]
    }),
});
const data = await response.json();

PUT/v1/platform-webhooks/{id}

Authorization

bearer

Path parameters

id*string

Body

application/json

urlstring

eventsarray of string

secretstring

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/v1/platform-webhooks/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Bearer",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

DELETE/v1/platform-webhooks/{id}

Authorization

bearer

Path parameters

id*string

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/v1/platform-webhooks/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer Bearer"
    },
});
const data = await response.json();