Webhooks

Subscribe a URL to events

POST/v1/webhooks

Requires an API key with the webhooks:write scope. About keys and scopes

Registers an HTTPS endpoint for the listed events, or * for every event including ones added later. Deliveries are signed with the returned secret (shown only here), retried with backoff, and paused by a circuit breaker while the endpoint keeps failing; see the webhooks guide. This is the subscribe call Zapier, Make and n8n make when a workflow turns on. A URL already subscribed returns 409 ALREADY_EXISTS; edit its events instead. Agent keys cannot hold webhooks:write.

Request body

urlstringrequired

The HTTPS endpoint that receives deliveries; it must resolve to a public host.

uri · up to 2000 characters

eventsstring[]required

Event types to receive, or ["*"] alone for every event, including future ones.

at least 1 item · at most 14 items

sourcestringoptional

The tool subscribing (zapier, …), so the dashboard can say who made it.

one of zapier, make, n8n, http_api

Returns

Returns 201 Created with a CreatedWebhook in data. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

urlstringrequired

uri

eventsstring[]required

The event types it receives.

sourcestring | nullrequired

The integration that created it; null when created directly.

one of zapier, make, n8n, http_api

statusstringrequired

disabled is set only by the platform; active re-enables it.

one of active, paused, disabled

previousSecretExpiresAtstring | nullrequired

Until when the replaced secret still signs requests after a rotation.

date-time

circuitOpenUntilstring | nullrequired

While set and in the future, deliveries to this endpoint wait: it failed five requests in a row. The next request after it is a probe; a success clears it.

date-time

createdAtstringrequired

date-time

secretstringrequired

Signs every delivery; shown once, here.

curl -X POST https://api.kirora.io/v1/webhooks \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "events": [
      "*"
    ]
  }'

const response = await fetch('https://api.kirora.io/v1/webhooks', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "events": [
      "*"
    ]
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "url": "https://example.com",
        "events": [
            "*",
        ],
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "url": "https://example.com",
	  "events": [
	    "*"
	  ]
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/webhooks", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 201

{
  "data": {
    "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    "url": "https://example.com",
    "events": [
      "*"
    ],
    "source": "zapier",
    "status": "active",
    "previousSecretExpiresAt": "2030-03-14T09:30:00Z",
    "circuitOpenUntil": "2030-03-14T09:30:00Z",
    "createdAt": "2030-03-14T09:30:00Z",
    "secret": "secret_example"
  }
}

Example values are generated from the schema.