Skip to main content
POST
Test webhook

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Headers

Idempotency-Key
string
required

Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

UUID of the webhook subscription in this request.

Body

application/json

Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.

event
enum<string>
required

Partner lifecycle event type to use for the test delivery; must be one the webhook is subscribed to. Case events are tested through the company's Case Management API test route.

  • company.created - company.created
  • company.case_submission_readiness.changed - company.case_submission_readiness.changed
  • company.access.confirmed - company.access.confirmed
  • company.access.revoked - company.access.revoked
  • company.access.restored - company.access.restored
  • company.user.added - company.user.added
  • company.user.revoked - company.user.revoked
  • company.user.activated - company.user.activated
  • company.user.invite_expired - company.user.invite_expired
Available options:
company.created,
company.case_submission_readiness.changed,
company.access.confirmed,
company.access.revoked,
company.access.restored,
company.user.added,
company.user.revoked,
company.user.activated,
company.user.invite_expired

Response

Accepted Partner webhook command response.

delivery_id
string<uuid>
required

Identifier of the delivery created by the command.

detail
string
required

Human-readable result of the accepted command.

event_id
string<uuid>
required

Identifier of the event queued for delivery.