Platform webhooks

PreviousAudit event mappings NextSet active

delete

Authorizations

Path parameters

idstringRequired

Responses

200Success

delete

DELETE /v1/platform-webhooks/{id} HTTP/1.1
Host: 
Authorization: Bearer Bearer
Accept: */*

200Success

No content

get

Authorizations

Responses

200Success

application/json

get

GET /v1/platform-webhooks HTTP/1.1
Host: 
Authorization: Bearer Bearer
Accept: */*

200Success

[
  {
    "id": "text",
    "url": "text",
    "isActive": true,
    "events": [
      "text"
    ],
    "createdAt": "2025-05-31T07:42:11.372Z",
    "lastUpdatedAt": "2025-05-31T07:42:11.372Z"
  }
]

post

Authorizations

Body

urlstringRequired

eventsstring[]Required

secretstringOptional

Responses

201Success

post

POST /v1/platform-webhooks HTTP/1.1
Host: 
Authorization: Bearer Bearer
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "text",
  "events": [
    "text"
  ],
  "secret": "text"
}

201Success

No content

put

Authorizations

Path parameters

idstringRequired

Body

urlstringOptional

eventsstring[]Optional

secretstringOptional

Responses

200Success

put

PUT /v1/platform-webhooks/{id} HTTP/1.1
Host: 
Authorization: Bearer Bearer
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "text",
  "events": [
    "text"
  ],
  "secret": "text"
}

200Success

No content