Test Superagent webhook

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Sends a sample message.completed delivery to a Superagent's webhook, so you can check your endpoint.

The delivery is signed when the webhook has a secret, and carries a unique X-Base44-Delivery header. A successful call means the test ran, not that your endpoint accepted it. Read ok for that. A failed test doesn't count toward consecutive_failures.

Base44 waits up to 10 seconds for your endpoint to answer.

<Note>This endpoint accepts a personal API key or personal access token belonging to an editor of the agent. A read-only key is refused, and workspace API keys are not accepted.</Note>

post/api/agents/{agent_id}/webhooks/{webhook_id}/test

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/agents/{agent_id}/webhooks/{webhook_id}/test
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

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

agent_idstring 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.

okboolean required

Whether your endpoint answered with a 2xx status.

status_codeinteger nullable

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

response_bodystring nullable

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

errorstring nullable

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 response

{
  "ok": true,
  "status_code": 200,
  "response_body": "ok",
  "error": "ConnectTimeout: timed out"
}

Changes