Webhooks

curl https://api.useinfrared.com/v1/webhooks \
  -H "Authorization: Bearer $INFRARED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://hooks.example.com/infrared",
    "description": "Syncs verdicts to the CMS",
    "event_types": [
      "moderation.completed",
      "queue_item.allowed",
      "queue_item.rejected"
    ]
  }'

const response = await fetch("https://api.useinfrared.com/v1/webhooks", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.INFRARED_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://hooks.example.com/infrared",
    description: "Syncs verdicts to the CMS",
    event_types: [
      "moderation.completed",
      "queue_item.allowed",
      "queue_item.rejected",
    ],
  }),
});

const endpoint = await response.json();

import os
import requests

response = requests.post(
    "https://api.useinfrared.com/v1/webhooks",
    headers={"Authorization": f"Bearer {os.environ['INFRARED_KEY']}"},
    json={
        "url": "https://hooks.example.com/infrared",
        "description": "Syncs verdicts to the CMS",
        "event_types": [
            "moderation.completed",
            "queue_item.allowed",
            "queue_item.rejected",
        ],
    },
)

endpoint = response.json()

// receiver.js
import express from "express";
import { constructEvent, SignatureError } from "./infrared-webhooks.js";

const app = express();
const seen = new Set(); // in production, a store that outlives the process

// express.raw keeps the body as bytes. Put it on this route, before any express.json().
app.post("/webhooks/infrared", express.raw({ type: "application/json" }), (req, res) => {
  let event;
  try {
    event = constructEvent(req.body, req.get("Infrared-Signature"), process.env.INFRARED_WEBHOOK_SECRET);
  } catch (error) {
    if (error instanceof SignatureError) return res.status(400).json({ error: error.message });
    throw error;
  }

  // Answer first: a delivery times out after 10 seconds.
  res.json({ received: true });

  // The event id is the same on every retry and on a replay.
  if (seen.has(event.id)) return;
  seen.add(event.id);
  handle(event);
});

function handle(event) {
  if (event.type === "moderation.completed") {
    const { id, recommendation } = event.data.moderation;
    console.log(id, recommendation); // publish, hold or reject the content here
  }
}

app.listen(process.env.PORT ?? 3000);

# receiver.py, run with: flask --app receiver run
import os

from flask import Flask, request

from infrared_webhooks import SignatureError, construct_event

app = Flask(__name__)
seen = set()  # in production, a store that outlives the process


@app.post("/webhooks/infrared")
def infrared_webhook():
    try:
        # request.get_data() is the raw body. Verify it before anything parses it.
        event = construct_event(request.get_data(), request.headers.get("Infrared-Signature"), os.environ["INFRARED_WEBHOOK_SECRET"])
    except SignatureError as error:
        return {"error": str(error)}, 400

    # The event id is the same on every retry and on a replay.
    if event["id"] not in seen:
        seen.add(event["id"])
        handle(event)

    return {"received": True}


def handle(event):
    # Keep this short, or hand the event to a queue: a delivery times out after 10 seconds.
    if event["type"] == "moderation.completed":
        moderation = event["data"]["moderation"]
        print(moderation["id"], moderation["recommendation"])  # publish, hold or reject the content here

curl -X PATCH https://api.useinfrared.com/v1/webhooks/whe_0dFoExHEccOjnJ7ZHHwXsq \
  -H "Authorization: Bearer $INFRARED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "disabled"
  }'

const response = await fetch("https://api.useinfrared.com/v1/webhooks/whe_0dFoExHEccOjnJ7ZHHwXsq", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.INFRARED_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    status: "disabled",
  }),
});

const endpoint = await response.json();

import os
import requests

response = requests.patch(
    "https://api.useinfrared.com/v1/webhooks/whe_0dFoExHEccOjnJ7ZHHwXsq",
    headers={"Authorization": f"Bearer {os.environ['INFRARED_KEY']}"},
    json={
        "status": "disabled",
    },
)

endpoint = response.json()