Orishare
API reference

List endpoints (secrets never shown)

GET
/webhook_endpoints

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhook_endpoints"
{  "data": [    {      "id": "string",      "url": "string",      "subscribed_types": [        "string"      ],      "status": "active",      "disabled_reason": "string",      "failing_since": "2019-08-24T14:15:22Z",      "secret_rotated_at": "2019-08-24T14:15:22Z",      "version": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Create an endpoint; the signing secret is returned once

POST
/webhook_endpoints

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook_endpoints" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/hooks",    "subscribed_types": [      "points.awarded"    ]  }'
{  "id": "string",  "url": "string",  "subscribed_types": [    "string"  ],  "status": "active",  "disabled_reason": "string",  "failing_since": "2019-08-24T14:15:22Z",  "secret_rotated_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "signing_secret": "string"}

One endpoint

GET
/webhook_endpoints/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhook_endpoints/string"
{  "id": "string",  "url": "string",  "subscribed_types": [    "string"  ],  "status": "active",  "disabled_reason": "string",  "failing_since": "2019-08-24T14:15:22Z",  "secret_rotated_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Change url, subscriptions, or re-enable a disabled endpoint

PATCH
/webhook_endpoints/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match?string

Optional legacy revision. Missing or malformed values follow the existing route parser.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/webhook_endpoints/string" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/hooks"  }'
{  "id": "string",  "url": "string",  "subscribed_types": [    "string"  ],  "status": "active",  "disabled_reason": "string",  "failing_since": "2019-08-24T14:15:22Z",  "secret_rotated_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Delete an endpoint and its delivery history

DELETE
/webhook_endpoints/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/webhook_endpoints/string"
Empty

Rotate the signing secret (returned once; the previous one verifies for 24 h)

POST
/webhook_endpoints/{id}/secrets

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook_endpoints/string/secrets"
{  "id": "string",  "url": "string",  "subscribed_types": [    "string"  ],  "status": "active",  "disabled_reason": "string",  "failing_since": "2019-08-24T14:15:22Z",  "secret_rotated_at": "2019-08-24T14:15:22Z",  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "signing_secret": "string"}

List deliveries (newest first)

GET
/webhook_deliveries

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
endpoint_id?string
status?string

Value in

  • "pending"
  • "delivered"
  • "dead"
  • "disabled"
event_type?string

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhook_deliveries"
{  "data": [    {      "id": "string",      "endpoint_id": "string",      "event_type": "string",      "event_id": "string",      "payload": null,      "status": "pending",      "attempts": 0,      "next_attempt_at": "2019-08-24T14:15:22Z",      "last_status": 0,      "last_error": "string",      "delivered_at": "2019-08-24T14:15:22Z",      "replay_of": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Send a webhook.test ping to one endpoint now

POST
/webhook_deliveries

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook_deliveries" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "endpoint_id": "whe_00000000000000000000000000000042",    "type": "webhook.test"  }'
{  "delivery": {    "id": "string",    "endpoint_id": "string",    "event_type": "string",    "event_id": "string",    "payload": null,    "status": "pending",    "attempts": 0,    "next_attempt_at": "2019-08-24T14:15:22Z",    "last_status": 0,    "last_error": "string",    "delivered_at": "2019-08-24T14:15:22Z",    "replay_of": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "attempt": {    "delivery_id": "string",    "status": "delivered",    "attempts": 0,    "http_status": 0,    "error": "string",    "next_attempt_at": "2019-08-24T14:15:22Z"  }}

One delivery with its envelope and attempt history

GET
/webhook_deliveries/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhook_deliveries/string"
{  "id": "string",  "endpoint_id": "string",  "event_type": "string",  "event_id": "string",  "payload": null,  "status": "pending",  "attempts": 0,  "next_attempt_at": "2019-08-24T14:15:22Z",  "last_status": 0,  "last_error": "string",  "delivered_at": "2019-08-24T14:15:22Z",  "replay_of": "string",  "created_at": "2019-08-24T14:15:22Z"}

Replay: a new delivery of the same envelope, queued for the dispatcher

POST
/webhook_deliveries/{id}/replay

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook_deliveries/string/replay" \  -H "Idempotency-Key: string"
{  "delivery": {    "id": "string",    "endpoint_id": "string",    "event_type": "string",    "event_id": "string",    "payload": null,    "status": "pending",    "attempts": 0,    "next_attempt_at": "2019-08-24T14:15:22Z",    "last_status": 0,    "last_error": "string",    "delivered_at": "2019-08-24T14:15:22Z",    "replay_of": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "attempt": {    "delivery_id": "string",    "status": "delivered",    "attempts": 0,    "http_status": 0,    "error": "string",    "next_attempt_at": "2019-08-24T14:15:22Z"  }}

Materialize deliveries for one outbox payload (relay hook; local and tests)

POST
/webhook_deliveries/fan_out

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook_deliveries/fan_out" \  -H "Content-Type: application/json" \  -d '{    "outbox_id": "ob_00000000000000000000000000000042",    "payload": {      "type": "webhook.test"    }  }'
{  "delivery_ids": [    "string"  ]}

Tiers

Tier programs, levels and per-customer tiers.

Error codes

Next Page