---
title: "Create a Webhook"
method: POST
path: "/2024-09/webhooks"
tags: ["Webhooks"]
---

# Create a Webhook

`POST /2024-09/webhooks`

Create a single webhook in your account.

Required authorization scope: `public.webhook:write`

## Request body

- union
  - WebhookCreate202301 — Create v2023_01 Webhook
    - `configuration` WebhookConfiguration, nullable
      - `credit_balance_low` object, nullable
        - `credit_balance_limit` number, nullable — Required only when event_types include `credit_balance_low`. The webhook would be triggered if the credit balance is lower than this limit. Please note that the webhook will only be triggered once a day and it will reset at 00:00 UTC.
    - `endpoint` Endpoint, required — unresolved $ref
    - `event_types` EventTypes, required — unresolved $ref
    - `version` Version — unresolved $ref
  - WebhookCreate202409 — Create v2024_09 Webhook
    - `configuration` WebhookConfiguration, nullable
      - `credit_balance_low` object, nullable
        - `credit_balance_limit` number, nullable — Required only when event_types include `credit_balance_low`. The webhook would be triggered if the credit balance is lower than this limit. Please note that the webhook will only be triggered once a day and it will reset at 00:00 UTC.
    - `endpoint` Endpoint, required — unresolved $ref
    - `event_types` EventTypes, required — unresolved $ref
    - `version` Version — unresolved $ref

## Response `201`

webhook successfully created

- WebhookSingle — Webhook details
  - `webhook` union
    - Webhook202301 — v2023_01 Webhook
      - `id` Id — unresolved $ref
      - `endpoint` Endpoint — unresolved $ref
      - `configuration` WebhookConfiguration, nullable
        - `credit_balance_low` object, nullable
          - `credit_balance_limit` number, nullable — Required only when event_types include `credit_balance_low`. The webhook would be triggered if the credit balance is lower than this limit. Please note that the webhook will only be triggered once a day and it will reset at 00:00 UTC.
      - `event_types` string[]
      - `version` '2023-01' — Webhook payload version. Refer to documentation for information regarding payload versioning.
      - `state` State — unresolved $ref
      - `secret_token` SecretToken — unresolved $ref
      - `updated_at` UpdatedAt — unresolved $ref
      - `created_at` CreatedAt — unresolved $ref
    - Webhook202409 — v2024_09 Webhook
      - `id` Id — unresolved $ref
      - `endpoint` Endpoint — unresolved $ref
      - `configuration` WebhookConfiguration, nullable
        - `credit_balance_low` object, nullable
          - `credit_balance_limit` number, nullable — Required only when event_types include `credit_balance_low`. The webhook would be triggered if the credit balance is lower than this limit. Please note that the webhook will only be triggered once a day and it will reset at 00:00 UTC.
      - `event_types` string[]
      - `version` '2024-09' — Webhook payload version. Refer to documentation for information regarding payload versioning.
      - `state` State — unresolved $ref
      - `secret_token` SecretToken — unresolved $ref
      - `updated_at` UpdatedAt — unresolved $ref
      - `created_at` CreatedAt — unresolved $ref
  - `meta` Meta
    - `request_id` string — An unique ID represent the request.

## Other responses

- `422` — failed version validation

---

[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)