API docs

Reference / Webhook

Read the webhook

GEThttps://app.booksbyinstant.com/api/integrator/v1/webhook

readWebhook · This page as markdown

Example request

cURL

curl -X GET 'https://app.booksbyinstant.com/api/integrator/v1/webhook' \
  -H "Authorization: Bearer $INTEGRATOR_CREDENTIAL"

JavaScript

// Node 18 or later, in an ES module (.mjs), which allows the top-level await.
const res = await fetch("https://app.booksbyinstant.com/api/integrator/v1/webhook", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.INTEGRATOR_CREDENTIAL}`,
  },
});
const data = await res.json();

Python

import os
import requests

res = requests.get(
    "https://app.booksbyinstant.com/api/integrator/v1/webhook",
    headers={
        "Authorization": f"Bearer {os.environ['INTEGRATOR_CREDENTIAL']}",
    },
)
data = res.json()

Authorization

Bearer token live_<100 hex>

Authorization: Bearer <secret>. A 401 answers WWW-Authenticate: Bearer realm="instant-integrator-api".

Responses

200

The webhook, never its secret, and how many deliveries are pending and failed.

Body application/json

object

  • webhook object or null required

    Null when no webhook is set.

    • url string required

      Where Instant posts the deliveries.

    • hint string required

      The signing secret's prefix, … and its last four hex characters.

      matches ^[a-z]+_w_…[0-9a-f]{4}$

    • setAt string · date-time required

      When the webhook was set, and its secret minted. ISO 8601 in UTC with milliseconds, such as 2026-11-06T10:00:00.000Z.

  • deliveries object required

    • pending integer required

      How many deliveries wait to be sent or retried.

      at least 0

    • failed integer required

      How many deliveries failed and will not be sent again.

      at least 0

Example, built from the schema

{
  "webhook": {
    "url": "string",
    "hint": "string",
    "setAt": "2026-01-15T09:30:00.000Z"
  },
  "deliveries": {
    "pending": 0,
    "failed": 0
  }
}

401

The credential is missing, malformed, unknown, revoked or rotated, or its integrator is disabled. All of these answer the same way.

Headers

  • WWW-Authenticate string

    Bearer realm="instant-integrator-api"

Body application/json

object Error

Every answer that is not a success.

  • error string required

    Instant's sentence for people. A 4xx keeps the refusal's own sentence; a 5xx always says "Instant is temporarily unavailable. Please try again shortly."

  • code string required

    Stable, and what a caller branches on: VALIDATION_ERROR (400), UNAUTHENTICATED (401), FORBIDDEN (403), NOT_FOUND (404), CONFLICT (409), LIMIT_EXCEEDED (413), UNSUPPORTED_MEDIA_TYPE (415), UNREADABLE_FILE (422), RATE_LIMITED (429) and UNAVAILABLE (5xx). More codes may be added; treat one you do not know by its status.

  • retryAfter integer

    Seconds to wait before retrying, also sent as the Retry-After header. Present only when there is a wait, as on a 429.

    at least 1

  • existingId string · uuid

    On a 409 that names the object already there, such as a customer with that reference: its id.

Example, built from the schema

{
  "error": "string",
  "code": "VALIDATION_ERROR",
  "retryAfter": 1,
  "existingId": "01900000-0000-7000-8000-000000000000"
}

5XX

Instant is temporarily unavailable. Retry later, with backoff.

Body application/json

The Error object, as in 401.