Test a Webhook Endpoint

Send a test event to one of your webhook endpoints, to confirm it’s receiving and can handle Relaybase events correctly.

Request

POST https://api.tryrelaybase.com/v1/webhooks/test
Authorization: Bearer rb_key_<token>
Content-Type: application/json

{
  "test_type": "bulk_validate_success",
  "webhook_id": "b6712266-6e2b-4b5c-b320-1cb7e6e4e00a"
}

Body parameters

Field	Type	Required	Description
`test_type`	string	Yes	One of `test_webhook`, `bulk_validate_success`, `bulk_validate_failed`
`webhook_id`	string	Yes	The `id` of the webhook endpoint to send the test event to — see List Webhook Endpoints

Response

Relaybase sends an event to your endpoint matching the test_type you requested. The event shape depends on which type you chose:

test_webhook → webhook.test

{
  "id": "1bf3c66b-8005-423d-a430-0645f3ebd70c",
  "type": "webhook.test",
  "created_at": "2026-08-30T22:30:57.374920312Z",
  "data": {
    "message": "This is a test webhook event from RelayBase. If you received this, your webhook is working correctly."
  }
}

bulk_validate_success → bulk.validation.completed

{
  "id": "a1b8dda9-b258-42fb-8c0f-f01be23bc8b5",
  "type": "bulk.validation.completed",
  "created_at": "2026-08-30T22:31:14.926317556Z",
  "data": {
    "completed_at": "2026-08-30T20:05:32Z",
    "invalid": 158,
    "job_id": "bulk_2x9p",
    "processed": 1000,
    "started_at": "2026-08-30T20:00:00Z",
    "status": "completed",
    "total_emails": 1000,
    "valid": 842
  }
}

bulk_validate_failed → bulk.validation.failed

{
  "id": "460461e1-ec29-4bc1-b6c3-6e5bb37ef956",
  "type": "bulk.validation.failed",
  "created_at": "2026-08-30T21:48:01.649292413Z",
  "data": {
    "error": "Validation process failed unexpectedly.",
    "job_id": "bulk_2x9p",
    "processed": 347,
    "status": "failed",
    "total_emails": 1000
  }
}

These test payloads are simulated for testing purposes — sending a test event doesn’t mean the referenced job (e.g. bulk_2x9p) is a real validation job in your account.

Getting Started

Concepts

API Reference

Plans

Resources

Test a Webhook Endpoint

Request

Body parameters

Response

​Request

​Body parameters

​Response

Request

Body parameters

Response