---
title: "Send a test event"
method: POST
path: "/v1/webhook_endpoints/{id}/ping"
tags: ["Webhook endpoints"]
---

# Send a test event

`POST /v1/webhook_endpoints/{id}/ping`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/webhook_endpoints/{id}/ping`
- Auth: HTTP bearer

Delivers a sample event to the endpoint right now, once, and reports what came back. If it can't be sent from here straight away, `outcome` is `pending` and `response_status` is null: the delivery is queued and goes out within five minutes, and its result appears in the delivery log. The delivery lands in the log like any other, so you can see exactly what was sent, and it carries both signature schemes.

**Scope:** `webhooks:write` (or `write`)

## Path parameters

- `id` string, required: Prefixed id (`whe_…`)

## Request body

- object
  - `event_type` string: Any type from the event catalogue. Defaults to `sale.created`.

## Response `200`

What the one attempt did

- object
  - `object` 'webhook_ping', required
  - `delivery_id` string, required
  - `outcome` string, required
  - `response_status` integer, nullable, required

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)