Skip to main content
POST

Overview

Sends a test payload to the webhook URL to verify connectivity and ensure your endpoint is properly configured to receive webhook events.

Endpoint

string
required
Agent UUID
string
required
Webhook UUID

Request

Test Payload

When you call the test endpoint, the following payload will be sent to your webhook URL:

Response

boolean
Indicates if the test webhook was sent successfully
string
Success message
object
Test results data
integer
HTTP status code returned by your webhook endpoint
integer
Response time in milliseconds

Error responses

Important notes

  • The test payload uses the webhook.test event type to distinguish it from real events
  • Your webhook endpoint should return a 2xx HTTP status code for successful tests
  • The test respects the webhook’s configured timeout and retry settings
  • Use this endpoint to verify connectivity before going live with webhook events
  • Test payloads include the test: true field to help identify them in your logs

Webhook Endpoint Requirements

Your webhook endpoint should:
  1. Accept POST requests with JSON payloads
  2. Return 2xx status codes for successful processing
  3. Respond within the configured timeout (default: 30 seconds)
  4. Handle the test event type appropriately
  5. Implement proper signature verification if using webhook secrets