Create an outbound webhook endpoint

POST/v1/webhook-endpoints

Authorization

AuthorizationBearer token · headerrequired

Public API key bearer token.

Query parameters

environmentstringrequired

merchantAccountIdstringrequired

Header parameters

Idempotency-Keystring

Required for production-safe retries on mutating routes. Reusing a key with a different request body returns 409.

min length 1

Request body

requiredapplication/json

urlstring<uri>required

descriptionstring

eventTypesstring[]required

min items 1

scopestring

Delivery scope. Omit for the ordinary per-merchant scope (events owned by this merchant account). `platform` is only valid on an operator-activated platform account and receives events owned by its linked sub-merchants.

Allowed:platform

Responses

200Success

dataobjectrequired

requestIdstringrequired

400Bad request, including malformed JSON

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

401Missing or invalid API key

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

409Conflict, including idempotency body drift

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

422Validation failed

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

429API key rate limit exceeded

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

defaultError

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

Request

curl -X POST "https://api.vortex.nyc/v1/webhook-endpoints?environment=string&merchantAccountId=string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<uri>",
  "description": "string",
  "eventTypes": [
    "string"
  ],
  "scope": "platform"
}'

const response = await fetch("https://api.vortex.nyc/v1/webhook-endpoints?environment=string&merchantAccountId=string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "url": "<uri>",
  "description": "string",
  "eventTypes": [
    "string"
  ],
  "scope": "platform"
})
});

import requests

response = requests.post(
    "https://api.vortex.nyc/v1/webhook-endpoints?environment=string&merchantAccountId=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "url": "<uri>",
  "description": "string",
  "eventTypes": [
    "string"
  ],
  "scope": "platform"
},
)

Response

{
  "data": {},
  "requestId": "string"
}