PApaychex
Webhooks

Add Webhook

<h3>Add a webhook for the calling application.</h3><p>When registering a webhook, you will need to provide your own URI in the request body (see our <a href='https://developer.paychex.com/resources/webhooks'>full webhook documention here</a> on how to configure your URI). The newly registered webhook will send notifications to this endpoint as JSON payloads which vary by domain. Please configure your endpoint to accept the relevant payloads. To see an example payload for each domain, please refer to the "Callbacks" tab.</p>
post/management/hooks

Request

Request body

hookIdstring

The unique identifier associated with this webhook. Not required for Posting.

uristring required

Enter a valid URL for the webhook to receive events.

companyIdstring

ID associated with desired company that will receive the webhook notifications. NOTE: If no Company ID is provided in the POST, then all companies linked to the app will receive notifications.

domainsstring[] required

List of available domains to register to. Refer to webhook documentation https://developer.paychex.com/documentation#operation/domains.

Response

Webhook successfully created.

hookIdstring
companyIdstring
uristring
authTypestring
createdDatestring date-time
activeboolean
domainsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.