Webhooks

Create Webhook

Create a webhook to use for callbacks from Pinwheel jobs.

post/webhooks

Request

Base URL
https://api.getpinwheel.com/v1
Auth
API key in header X-API-SECRET
TypeScript
https://skmtc.dev/getpinwheel/apis/pinwheel/docs/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

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.

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'2023-11-22' | '2023-04-18' | '2022-09-09' | '2023-07-18' | '2025-07-08' 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.

Jul 31, 2026372b93d1c20d Revision 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