PApaylocity
Subscriptions

Update Subscription

🚧 Early Access API Version This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

Updates an existing webhook subscription using the provided id. This endpoint enables clients to modify specific aspects of the subscription—such as the target URL, event types, or authentication settings without requiring the subscription to be recreated.

patch/apiHub/webhooks/v1/subscriptions/{id}

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/webhooks/v1/subscriptions/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The unique identifier of the webhook subscription to update.

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

Response

OK. Returned when the update changes authentication settings. Contains the resulting HMAC key details, including the secret of any newly created key.

typestring nullable

The authentication type configured for the subscription. Allowable Values: HMAC.

Example response

{
  "type": "HMAC"
}

Changes

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