Create or update your webhook configuration with a URL and optional signing secret.

Set Webhook Config

PUT /api/v1/webhook-config

Create or update your webhook configuration. When a command completes, RenderIO sends a POST request to your configured URL with the command results. If you previously had a webhook that was auto-disabled due to failures, this endpoint resets the failure counter and re-enables delivery.

Authentication

Requires API key via X-API-KEY header.

Request

Headers

Header	Type	Required	Description
`Content-Type`	`string`	Yes	Must be `application/json`
`X-API-KEY`	`string`	Yes	Your API key with `ffsk_` prefix

Body

{
  url: string;
  secret?: string;
}

Field	Type	Required	Description
`url`	`string`	Yes	The URL to receive webhook POST requests. Must be a valid URL.
`secret`	`string`	No	A secret string used to compute HMAC-SHA256 signatures for webhook payloads. If provided, each delivery includes an `X-Webhook-Signature` header.

Response

200 OK

{
  success: true;
  url: string;
}

Field	Type	Description
`success`	`boolean`	Always `true` on success.
`url`	`string`	The configured webhook URL.

Error responses

Status	Error	Description
`401`	`UNAUTHORIZED`	Missing or invalid API key.
`422`	`VALIDATION_ERROR`	URL is missing or not a valid URL.
`429`	`RATE_LIMITED`	Too many requests. Retry after the period indicated in the `Retry-After` header.

Examples

curl

curl -X PUT https://renderio.dev/api/v1/webhook-config \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: ffsk_your_api_key_here" \
  -d '{
    "url": "https://example.com/webhooks/renderio",
    "secret": "whsec_your_signing_secret"
  }'

JavaScript (fetch)

const response = await fetch(
  "https://renderio.dev/api/v1/webhook-config",
  {
    method: "PUT",
    headers: {
      "Content-Type": "application/json",
      "X-API-KEY": "ffsk_your_api_key_here",
    },
    body: JSON.stringify({
      url: "https://example.com/webhooks/renderio",
      secret: "whsec_your_signing_secret",
    }),
  },
);

const result = await response.json();
console.log("Webhook configured:", result.url);

Python (requests)

import requests

response = requests.put(
    "https://renderio.dev/api/v1/webhook-config",
    headers={
        "Content-Type": "application/json",
        "X-API-KEY": "ffsk_your_api_key_here",
    },
    json={
        "url": "https://example.com/webhooks/renderio",
        "secret": "whsec_your_signing_secret",
    },
)

result = response.json()
print("Webhook configured:", result["url"])

Set Webhook Config

On this page