Webhooks

Send a test event

POST/v1/webhooks/{id}/test

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

Queues a webhook.test event to this endpoint, signed and retried like any other, and returns the delivery to watch.

Path parameters

idstringrequired: uuid

Returns

Returns 202 Accepted. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

subscriptionIdstringrequired

The webhook (endpoint) it was sent to.

uuid

eventIdstringrequired

The event; the same across retries.

uuid

eventTypestringrequired

The event type, such as message.delivered.

attemptintegerrequired

Which attempt this was, starting at 1.

min -9007199254740991 · max 9007199254740991

statusstringrequired

one of pending, delivered, failed

responseStatusinteger | nullrequired

The HTTP status your endpoint answered with; null if it did not answer.

min -9007199254740991 · max 9007199254740991

failureReasonstring | nullrequired

Why the attempt failed.

requestBodystring | nullrequired

What was sent; kept only while a delivery is pending or failed.

responseBodystring | nullrequired

The first 1 KB of the endpoint's last reply.

createdAtstringrequired

date-time

deliveredAtstring | nullrequired

When your endpoint accepted it.

date-time

curl -X POST https://api.kirora.io/v1/webhooks/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/test \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/webhooks/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/webhooks/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/test",
    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("POST", "https://api.kirora.io/v1/webhooks/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/test", 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 · 202

{
  "data": {
    "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    "subscriptionId": "018f2a4e-6b1c-7d3e-9f40-77e633395a6b",
    "eventId": "018f2a4e-6b1c-7d3e-9f40-8f3712f25a6b",
    "eventType": "eventType_example",
    "attempt": -9007199254740991,
    "status": "pending",
    "responseStatus": -9007199254740991,
    "failureReason": "failureReason_example",
    "requestBody": "requestBody_example",
    "responseBody": "responseBody_example",
    "createdAt": "2030-03-14T09:30:00Z",
    "deliveredAt": "2030-03-14T09:30:00Z"
  }
}

Example values are generated from the schema.