Skip to content
dropin

Send a test event to this tenant's webhook destinations

POST
/operator/webhooks/test
curl --request POST \
  --url http://localhost:3000/operator/webhooks/test \
  --header 'Authorization: Bearer <token>'

Fires one webhook.test event through the same pipeline as a real domain event, so the operator can verify their endpoint receives what they expect. The event type is deliberately distinct from anything the tenant’s handler ingests as a domain event — a test shaped like activity.added would be processed by their handler and create a phantom post in their production app.

owner only: this button calls the tenant’s real endpoint. Rate-limited at one call per tenant per 10 seconds, the same margin as the spec’s other write-side controls; an attacker with an owner cookie cannot use it as a stress test.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

202

Section titled “202”

Test event enqueued.

Media typeapplication/json
object
emitted
boolean
Examplegenerated
{
  "emitted": true
}

401

Section titled “401”

Invalid, expired, revoked, or absent token.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}

403

Section titled “403”

Caller lacks the test ability (member), or is platform staff with no tenant.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}

429

Section titled “429”

Rate limited — one test event per tenant per 10 seconds.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL
message
required
string
requestId
required
string
fields

Present only for VALIDATION_FAILED.

Array<object>
object
path
string
message
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}