Send a test webhook

Sends a synthetic alert.match.created payload to every active webhook connection attached to this alert, so you can verify your endpoint end to end — receipt, signature, and parsing — without waiting for a real match. The payload is byte-for-byte shaped like a live delivery and carries this alert’s real id, title, kind, and first watched entity, but its match content is illustrative sample data and the envelope is flagged test: true so your handler can skip real side effects. Nothing is persisted — a test never appears in the alert’s delivery log. Returns one result per connection the test was POSTed to: whether the endpoint accepted the POST, its status code, and any error. Channels whose connection has been deleted are skipped and don’t appear in the results. A down or non-2xx endpoint is reported as delivered: false rather than failing the request. Returns 422 when the alert has no active webhook connection — either none is configured, or every configured connection has been deleted.

POST /v1/alerts/{id}/test-webhook

cURL

cURL

curl -X POST \
  -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/alerts/{id}/test-webhook"

200

{
  "deliveries": [
    {
      "delivered": true,
      "url": "<string>",
      "webhook_connection_id": "<string>",
      "duration_ms": 123,
      "error": "<string>",
      "status_code": 123
    }
  ]
}

Prefer the terminal? This endpoint is also a command in the Particle CLI: pick Particle CLI in the request example’s language menu. Install the Particle CLI.

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Headers

Idempotency-Key · string

A key you choose, such as a UUID, to retry this request safely. Resend the same key with the same request and the first response is returned with Idempotent-Replayed: true instead of the request running again, for 24 hours after it succeeded. The same key with a different request returns 422 idempotency_key_reused; a retry while the first request is still running returns 409 idempotency_key_in_use. A request that fails does not use up its key.

Required string length: 8 - 128

Path Parameters

id · string · required

Alert ID

Response

200

application/json

OK

deliveries · object[] | null · required

One entry per active webhook connection the test was POSTed to, in the order attempted. A channel whose connection has been deleted is skipped and does not appear here.

Show child attributes