---
title: "Update a Webhook"
method: PATCH
path: "/2024-11/organizations/{organization_id}/webhooks/{webhook_id}"
tags: ["Webhooks"]
---

# Update a Webhook

`PATCH /2024-11/organizations/{organization_id}/webhooks/{webhook_id}`

## Request

- Base URL: `https://enterprise-api.easyship.com`
- URL: `https://enterprise-api.easyship.com/2024-11/organizations/{organization_id}/webhooks/{webhook_id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://enterprise-api.easyship.com/oauth2/token` scopes: `enterprise.webhook`

Update a single webhook in the organization.

Required authorization scope:  `enterprise.webhook:write`

## Path parameters

- `organization_id` string, uuid, required
- `webhook_id` string, required

## 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 `200`

webhook successfully updated

- 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

- `404`: no record found
- `422`: failed validations

---

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