Create a Webhook subscription

POST /v1/webhooks

Creates an active subscription at revision 1 and answers it with its new secret, which no later read shows (1.63.0; api.md section 7). The URL passes the egress guard's save-time rules (egress_denied at /url) and the selection its rules (WebhookSelectionIssueCode), each a detail of 422 validation_failed; a filter the Organization lacks is not_found. Deliveries start with the next event it selects, signed with Vocal-Signature. From 1.64.0, stated as the api built it: a request repeated under the same Idempotency-Key by the same credential answers the stored answer with the secret again while it is still the subscription's current secret, and writes the Audit event webhooks.subscription.secret_read; once the subscription is deleted the repeat is not_found, and once the secret is rotated it is 409 idempotency_key_reused, the secret never shown again.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/webhooks" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.test/a" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/webhooks`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://example.test/a"
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "url": "https://example.test/a",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: WebhookSubscriptionCreateRequest.

Responses

Fields of the 201 answer

The shape is WebhookSubscriptionCreated.