GEgetpinwheel
Webhooks

Update Webhook

Changed on

Update webhook.

put/webhooks/{webhook_id}

Request

Path parameters

webhook_idstring uuid required

UUID of the webhook.

Headers

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

Request body

urlstring uri

The URL of the webhook endpoints. Must be 'https://'.

status'active' | 'paused'

The status of the webhook.

enabled_eventsstring[]

The list of events enabled for this webhook.

customer_idstring

Banking platforms webhooks only: the customer ID associated with the platform's customer.

Response

OK

Changes

  • 372b93d1c20dRevision changes
    • breaking

      removed the enum value paycheck_viewer.added of the request property /

    • info

      removed the paycheck_viewer.added enum value from the // response property for the response status