Proteside Docs
Endpoint referenceWebhooks

Send a test event

POST
/webhooks/{id}/test

Delivers a test event through the dispatcher and reports the outcome synchronously.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Path Parameters

id*string
Formatuuid

Query Parameters

org_id?string

Partners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.

Formatuuid

Response Body

Delivery result

application/json
  1. response
id?string
Formatuuid
delivered?boolean
error?string|null
curl -X POST "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"
{  "id": "a9b8c7d6-0000-4111-8222-333344445555",  "delivered": true,  "error": null}