Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeWebhooks

List an org's webhooks (no secrets)

Returns every webhook in the org with its URL, subscribed events, enabled flag and secret prefix. The full signing secret is shown only on create or regenerate.

Required permission

Requires the webhook.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl webhooks list
GET
/v1/orgs/{orgId}/webhooks

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string

Response Body

Webhooks

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/webhooks'
Example Response
[  {    "id": "string",    "name": "string",    "url": "string",    "secretPrefix": "string",    "events": [      "string"    ],    "enabled": true,    "createdAt": "string",    "updatedAt": "string"  }]

Overview

Receive signed, retried HTTP callbacks for VM, batch and balance events in your organization, and verify each delivery's HMAC-SHA256 signature.

Create a webhook (secret returned once) POST

Registers an HTTPS URL for the events you list and returns the webhook with its whsec_ signing secret, the only time that secret is returned. Each delivery is a signed POST of {id, type, created_at, data}. Listing a batch event needs batch read access and a balance event billing read access, beside webhook write access (403 otherwise). A name the platform sends no event for is stored and never delivered.