Skip to main content
POST
Test Superagent webhook

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

webhook_id
string
required

ID of the webhook to test. Get it from List Superagent webhooks.

agent_id
string
required

ID of the Superagent. It's the agent's app ID, shown in the agent's developer settings.

Response

How your endpoint answered the test.

The outcome of a test delivery.

ok
boolean
required

Whether your endpoint answered with a 2xx status.

Example:

true

status_code
integer | null

HTTP status your endpoint answered with. Present only when it answered.

Example:

200

response_body
string | null

Start of your endpoint's response body, up to 1,024 bytes. Present only when it answered.

Example:

"ok"

error
string | null

Why the delivery didn't get an answer, such as a timeout or a URL Base44 refuses to call. Present only when it didn't.

Example:

"ConnectTimeout: timed out"