---
title: "Test a Webhook"
method: POST
path: "/2024-09/webhooks/{webhook_id}/test"
tags: ["Webhooks"]
---

# Test a Webhook

`POST /2024-09/webhooks/{webhook_id}/test`

Test a single webhook in your account.

Required authorization scope: `public.Webhook`

## Path parameters

- `webhook_id` string, required

## Request body

- union
  - WebhookTestCreate202301 — Test v2023_01 Webhook
    - `event_type` 'shipment_label_created' | 'shipment_tracking_checkpoints_created' | 'shipment_tracking_status_changed' | 'shipment_cancelled' | 'shipment_label_failed' | 'shipment_warehouse_state_updated' | 'batch_started' | 'batch_finished' | 'batch_item_finished' | 'credit_balance_low' | 'courier_account_state_changed' | 'external_shipment_insured' | 'oauth_authorization_revoked', required — Webhook event type
    - `version` Version — unresolved $ref
  - WebhookTestCreate202409 — Test v2024_09 Webhook
    - `event_type` 'shipment_label_created' | 'shipment_tracking_checkpoints_created' | 'shipment_tracking_status_changed' | 'shipment_cancelled' | 'shipment_label_failed' | 'shipment_warehouse_state_updated' | 'batch_started' | 'batch_finished' | 'batch_item_finished' | 'credit_balance_low' | 'courier_state_changed' | 'external_shipment_insured' | 'oauth_authorization_revoked', required — Webhook event type
    - `version` Version — unresolved $ref

## Response `200`

webhook successfully tested

- Success — General success response
  - `success` object
    - `message` string
  - `meta` Meta
    - `request_id` string — An unique ID represent the request.

## Other responses

- `400` — failed to test webhook
- `422` — event_type is invalid
- `429` — too many requests

---

[API](https://skmtc.net/easyship/apis/easyship-public-api.md) · [All operations](https://skmtc.net/easyship/apis/easyship-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easyship/easyship-public-api/revisions/71d737a5fcbf/schema)