Create Webhook

post

https://api.getpinwheel.com/v1/webhooks

Create a webhook to use for callbacks from Pinwheel jobs.

Body Params

customer_id

string

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

enabled_events

array of strings

required

length ≥ 1

The list of events enabled for this webhook.

enabled_events*

status

string

enum

required

The status of the webhook.

Allowed:

url

string

required

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

version

string

enum

required

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

Allowed:

Headers

Pinwheel-Version

string

enum

required

Defaults to 2025-07-08

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

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK