Update Webhook

put

https://api.getpinwheel.com/v1/webhooks/{webhook_id}

Update webhook.

Path Params

webhook_id

uuid

required

UUID of the webhook.

Body Params

enabled_events

array of strings

length ≥ 1

The list of events enabled for this webhook. Allowed Values: account.added, account.monitoring_status.updated, direct_deposit_allocations.added, direct_deposit_switch.added, employment.added, identity.added, income.added, paystubs.added, paystubs.documents.added, paystubs.fully_synced, paystubs.ninety_days_synced, paystubs.seven_days_synced, paystubs.thirty_days_synced, shifts.added, shifts.fully_synced, shifts.ninety_days_synced, shifts.seven_days_synced, shifts.thirty_days_synced.

enabled_events

status

string

enum

The status of the webhook. Allowed Values: active, paused.

Allowed:

url

string

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

Headers

Pinwheel-Version

string

enum

required

Defaults to 2022-03-02

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