Create webhook subscription

POST/workspaces/{organizationId}/webhook-subscriptions

Path parameters

organizationIdstringrequired

Request body

application/json

urlstring<uri>required

eventsstring

secretstring

Responses

201Webhook subscription created

idstringrequired

organizationIdstringrequired

urlstringrequired

eventsstringrequired

secretstringrequired

createdAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

urlstring*eventsstringsecretstring

Request

curl -X POST "/workspaces/string/webhook-subscriptions" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "http://example.com",
  "events": "string",
  "secret": "string"
}'

const response = await fetch("/workspaces/string/webhook-subscriptions", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"url\": \"http://example.com\",\n  \"events\": \"string\",\n  \"secret\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/webhook-subscriptions",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"url\": \"http://example.com\",\n  \"events\": \"string\",\n  \"secret\": \"string\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "url": "string",
  "events": "string",
  "secret": "string",
  "createdAt": "string"
}