---
title: "Test a platform webhook"
method: POST
path: "/platform/webhooks/{webhookId}/test"
tags: ["Platform Webhooks"]
---

# Test a platform webhook

`POST /platform/webhooks/{webhookId}/test`

Send a test payload to your platform webhook endpoint.

Use this to:
- Verify your webhook URL is accessible
- Test your payload handling code
- Ensure your server responds correctly

The test payload is marked with `_test: true` so you can distinguish
test events from real events.

## Path parameters

- `webhookId` string, required

## Request body

- object
  - `event` 'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError', required — Event type to simulate

## Response `200`

Test result

- PlatformWebhookTestResponse
  - `success` true, required
  - `data` object, required
    - `success` boolean, required — Whether the webhook endpoint responded with a 2xx status
    - `statusCode` integer, required — HTTP status code from the webhook endpoint
    - `durationMs` integer, required — Request duration in milliseconds
    - `error` string, nullable — Error message if the request failed
  - `meta` ApiMeta, required
    - `requestId` string, required — Unique request identifier for debugging and support

## Other responses

- `400` — Invalid request parameters
- `401` — Invalid or missing API key
- `404` — Resource not found
- `429` — Rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.net/arkhq-io/apis/ark-email-api.md) · [All operations](https://skmtc.net/arkhq-io/apis/ark-email-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arkhq-io/ark-email-api/revisions/98a90852ffca/schema)