Retrieve your current webhook configuration, including URL, status, and failure count.

Get Webhook Config

GET /api/v1/webhook-config

Retrieve your current webhook configuration. Returns the configured URL, whether the webhook is active, and the consecutive failure count.

Authentication

Requires API key via X-API-KEY header.

Request

Headers

Header	Type	Required	Description
`X-API-KEY`	`string`	Yes	Your API key with `ffsk_` prefix

Response

200 OK (configured)

When a webhook URL has been set:

{
  configured: true;
  url: string;
  is_active: boolean;
  consecutive_failures: number;
  disabled_at: string | null;
}

Field	Type	Description
`configured`	`boolean`	Always `true` when a webhook is configured.
`url`	`string`	The URL that receives webhook POST requests.
`is_active`	`boolean`	Whether the webhook is currently active. Set to `false` after 8 consecutive failures.
`consecutive_failures`	`number`	Number of consecutive delivery failures. Resets to `0` on a successful delivery.
`disabled_at`	`string \| null`	ISO 8601 timestamp of when the webhook was auto-disabled, or `null` if still active.

200 OK (not configured)

When no webhook URL has been set:

{
  configured: false;
}

Error responses

Status	Error	Description
`401`	`UNAUTHORIZED`	Missing or invalid API key.
`429`	`RATE_LIMITED`	Too many requests. Retry after the period indicated in the `Retry-After` header.

Examples

curl

curl https://renderio.dev/api/v1/webhook-config \
  -H "X-API-KEY: ffsk_your_api_key_here"

JavaScript (fetch)

const response = await fetch(
  "https://renderio.dev/api/v1/webhook-config",
  {
    headers: {
      "X-API-KEY": "ffsk_your_api_key_here",
    },
  },
);

const config = await response.json();

if (config.configured) {
  console.log(`Webhook URL: ${config.url}`);
  console.log(`Active: ${config.is_active}`);
  console.log(`Failures: ${config.consecutive_failures}`);
} else {
  console.log("No webhook configured");
}

Python (requests)

import requests

response = requests.get(
    "https://renderio.dev/api/v1/webhook-config",
    headers={"X-API-KEY": "ffsk_your_api_key_here"},
)

config = response.json()

if config["configured"]:
    print(f"Webhook URL: {config['url']}")
    print(f"Active: {config['is_active']}")
    print(f"Failures: {config['consecutive_failures']}")
else:
    print("No webhook configured")

Get Webhook Config

On this page