Events

Cancel what an event set off

POST/v1/events/{id}/cancel

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

Ends the journey runs this event started that are still going, so a message waiting on a delay is never sent: track Cart Abandoned, then cancel it when the order arrives. A message already handed to the provider is not recalled, and the event stays in the contact's history. Cancelling twice ends nothing more. Runs end with the exit reason cancelled.

Path parameters

idstringrequired: uuid

Returns

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

idstringrequired

uuid

cancelledRunsintegerrequired

Journey runs this event started that were still going, now ended.

min 0 · max 9007199254740991

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

const response = await fetch('https://api.kirora.io/v1/events/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/cancel', {
  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/events/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/cancel",
    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/events/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/cancel", 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": {
    "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    "cancelledRuns": 0
  }
}

Example values are generated from the schema.