Webhooks

List webhook events

GET/v1/webhooks/events

Event types a subscription may listen for, each with what fires it and an example delivery body, plus the "*" wildcard that also covers events added later. Each event's full schema is in this document's webhooks section. Any valid key.

Returns

Returns 200 OK with a WebhookEventCatalogue in data. Otherwise returns an error; Errors lists every code and which to retry.

eventsobject[]required

5 child attributes

valuestringrequired

The event type, such as message.delivered.

one of contact.created, contact.unsubscribed, contact.consent_changed, form.submitted, campaign.sent, journey.enrolled, message.delivered, message.bounced, message.complained, message.opened, message.clicked, message.failed, message.skipped, message.sent

resourcestringrequired

The part of the event type before the dot.

actionstringrequired

The part of the event type after the dot.

descriptionstringrequired

What fires the event.

exampleobjectrequired

A whole delivery body: trigger samples for Zapier, Make and n8n.

wildcard"*"required

curl https://api.kirora.io/v1/webhooks/events \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/webhooks/events', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

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

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/webhooks/events", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	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 · 200

{
  "data": {
    "events": [
      {
        "value": "contact.created",
        "resource": "resource_example",
        "action": "action_example",
        "description": "description_example",
        "example": {}
      }
    ],
    "wildcard": "*"
  }
}

Example values are generated from the schema.