Skip to content

Webhooks

Endpoints in the Webhooks group. All paths are relative to https://rmhstudios.com.

GET/api/v1/webhooksmanage:webhooks

Your registered webhook endpoints.

Example response

{
  "data": [
    {
      "id": "wh_1",
      "url": "https://example.com/hook",
      "events": [
        "post.created"
      ],
      "enabled": true,
      "createdAt": "2026-06-01T00:00:00.000Z"
    }
  ]
}
POST/api/v1/webhooksmanage:webhooksidempotent

Register a URL to receive HMAC-signed event deliveries. The signing `secret` is returned once.

Body

  • url (string, required) — HTTPS URL to deliver events to.
  • events (string[], required) — Event names to subscribe to, or `["*"]` for all. See the Webhooks guide.
  • description (string) — Optional label.

Example request

{
  "url": "https://example.com/hook",
  "events": [
    "post.created",
    "follow.created"
  ]
}

Example response (201)

{
  "id": "wh_1",
  "url": "https://example.com/hook",
  "events": [
    "post.created",
    "follow.created"
  ],
  "enabled": true,
  "secret": "whsec_…",
  "createdAt": "2026-06-01T00:00:00.000Z"
}
GET/api/v1/webhooks/{id}manage:webhooks

One webhook endpoint with recent delivery attempts.

Parameters

  • id (path, required) — The webhook id.

Example response

{
  "id": "wh_1",
  "url": "https://example.com/hook",
  "events": [
    "post.created"
  ],
  "enabled": true,
  "failureCount": 0,
  "recentDeliveries": []
}
PATCH/api/v1/webhooks/{id}manage:webhooks

Update the URL, subscribed events, description, or enabled state.

Parameters

  • id (path, required) — The webhook id.

Body

  • url (string) — New HTTPS URL.
  • events (string[]) — New event subscription list.
  • description (string) — New label.
  • enabled (boolean) — Enable or disable deliveries.

Example request

{
  "enabled": false
}

Example response

{
  "id": "wh_1",
  "url": "https://example.com/hook",
  "events": [
    "post.created"
  ],
  "enabled": false
}
DELETE/api/v1/webhooks/{id}manage:webhooks

Permanently remove a webhook endpoint.

Parameters

  • id (path, required) — The webhook id.