Skip to content

Send a test event

POST
/organization_webhooks/{extId}/test
curl --request POST \
--url https://api.retorio.com/be/v2/organization_webhooks/9d4e2b71_3c8a_4f05_b6e2_1a7c5d9e0f38/test \
--header 'Authorization: Bearer <token>'

Sends a synchronous webhook.test event to the webhook, signed exactly like a real delivery, so you can verify your receiver end to end. Sent even when the webhook is disabled, so you can create it with isEnabled: false, test it, then enable it: a webhook created enabled receives its subscribed events right away. Recorded as a delivery, so it also shows up in the delivery log. It is never retried.

Auth
Access key
Roles
Owner / Custom
extId
required
string

Example

9d4e2b71_3c8a_4f05_b6e2_1a7c5d9e0f38

OK

Media typeapplication/json
object
succeeded
required
boolean
statusCode
required
integer
nullable
error
required
string
nullable

Example generated

{
"succeeded": true,
"statusCode": 1,
"error": "example"
}

Not authenticated: the bearer token is missing, malformed, expired or revoked, its sign-in method does not match your organization’s configuration, the user it belongs to was removed, or your organization is deactivated.

Media typeapplication/json
object
message
required
string
status
required

Canonical error name, e.g. INVALID_ARGUMENT.

string
details
nullable

Example generated

{
"message": "example",
"status": "example",
"details": "example"
}

Refused: the token does not belong to an admin, or the admin’s roles do not grant webhooks:manage.

Media typeapplication/json
Any of:
object
message
required
string
status
required

Canonical error name, e.g. INVALID_ARGUMENT.

string
details
nullable

Example generated

{
"message": "example",
"status": "example",
"details": "example"
}

No webhook with this extId in your organization.

Media typeapplication/json
object
message
required
string
status
required

Canonical error name, e.g. INVALID_ARGUMENT.

string
details
nullable

Example generated

{
"message": "example",
"status": "example",
"details": "example"
}

Internal Server Error

Media typeapplication/json
object
key
additional properties
nullable

Example generated

{
"additionalProperty": "example"
}

Retorio is GDPR and DSGVO compliant, EU AI Act aligned, ISO 27001 certified, and hosted on Google Cloud with EU data residency. For anything specific to your rollout, ask your Retorio contact.