Sign in
Webhooks

Create Webhook

Create a webhook to use for callbacks from Pinwheel jobs.

post/webhooks

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 required

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

status'active' | 'paused' required

The status of the webhook.

enabled_eventsstring[] required

The list of events enabled for this webhook.

version'2025-07-08' | '2022-09-09' | '2023-11-22' | '2023-07-18' | '2023-04-18' required

The webhook's version, which determines the format of the webhook event payloads.

customer_idstring

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

Response

OK

Changes

Changed in 1 of the 8 revisions of this API.11

  • 372b93d1c20d11See the full diff
    • ▲

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

      request-property-enum-value-removed

    • ○

      removed the paycheck_viewer.added enum value from the data/enabled_events/items/ response property for the response status 200

      response-property-enum-value-removed