{
  "event_id": "<string>",
  "org_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "data": "<unknown>"
}

A warmr event delivered to your configured endpoint

Warmr POSTs a signed JSON body to your URL. Verify with X-Warmr-Signature: sha256=<hmac-sha256(rawBody, secret)>. Delivery is at-least-once; dedupe on X-Warmr-Event-Id. Retries: up to 5 attempts over 72h.

Compute the HMAC over the RAW request body (not a re-serialized object) using the signing secret returned once when you created the webhook, then compare in constant time:

import crypto from "node:crypto";
// The SDK ships this as verifyWebhookSignature(rawBody, header, secret).
function verify(rawBody, header, secret) {
  const expected = "sha256=" + crypto.createHmac("sha256", secret).update(rawBody).digest("hex");
  const a = Buffer.from(header ?? ""), b = Buffer.from(expected);
  return a.length === b.length && crypto.timingSafeEqual(a, b);
}

WEBHOOK

warmrEvent

{
  "event_id": "<string>",
  "org_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

The access_token from the exchange endpoint.

Headers

X-Warmr-Event

string

X-Warmr-Event-Id

string

X-Warmr-Signature

string

required

Pattern: ^sha256=[0-9a-f]{64}$

Body

application/json

event_id

string

required

type

enum<string>

required

Available options:

run.completed,

run.failed,

webhook.ping

org_id

string

required

created_at

string<date-time>

required

data

any

required

Event-specific payload.

Response

2XX

Acknowledge receipt (any 2xx marks the delivery delivered).

Cloud API

API reference

A warmr event delivered to your configured endpoint

Authorizations

Headers

Body

Response