Create a webhook endpoint

POST/webhooks

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Request body

requiredapplication/json

namestringrequired

urlstring<uri>required

eventsstring[]required

descriptionstring

Responses

200

Created (includes full secret once)

idstringrequired

secretstringrequired

400

Invalid request parameters

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST "https://api.seal.nyc/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "url": "http://example.com",
  "events": [
    "string"
  ],
  "description": "string"
}'

const response = await fetch("https://api.seal.nyc/api/v1/webhooks", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"url\": \"http://example.com\",\n  \"events\": [\n    \"string\"\n  ],\n  \"description\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/webhooks",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"url\": \"http://example.com\",\n  \"events\": [\n    \"string\"\n  ],\n  \"description\": \"string\"\n}",
)

Response

{
  "id": "string",
  "secret": "string"
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "title": "Validation failed",
  "details": {
    "email": [
      "Must be a valid email address"
    ]
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}