For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Update webhook delivery or subscription configuration. Changing the URL or the authentication token invalidates the endpoint’s current ownership verification: the webhook is disabled and moved back to pending verification until it is re-verified.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
notification_endpoint_idstringRequired
The ID of the webhook endpoint.
Headers
X-Penny-As-Businessstring or nullOptional
Act on behalf of another business that has granted you access. Requires the business:act_as permission.
Query parameters
reveal_sensitivebooleanOptionalDefaults to false
Whether to include unmasked sensitive fields in the response. Defaults to false.
Request
This endpoint expects an object.
urlstring or nullOptionalformat: "^https://\S+$"
Replacement HTTPS destination URL.
trigger_eventslist of enums or nullOptional
Complete replacement set of notification events.
filter_identifierslist of strings or nullOptional
Complete replacement set of object filters.
authentication_tokenstring or nullOptional
Replacement bearer token. Omit to keep the current token; explicitly set null to remove it. Write-only: never returned in webhook responses.
Response
The updated webhook.
notification_endpoint_idstring
Penny's unique identifier for this endpoint.
versioninteger
A number that increases each time this endpoint's details change. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this endpoint's details were last changed.
business_idstring
The business this endpoint belongs to.
statusenum
This endpoint’s current status: ‘pending_setup’, ‘setup_failed’, ‘pending_verification’, ‘verification_failed’, ‘updating’, ‘active’, ‘deactivated’, ‘suspended’, or ‘archived’.
enabledboolean
Whether this endpoint currently receives deliveries.
updatingboolean
Whether this endpoint is currently being updated.
archivedboolean
Whether this endpoint has been permanently retired.
created_timedatetime
When this endpoint was registered.
verificationobject
The ownership-verification state of this endpoint.
suspensionobject
Whether this endpoint is currently suspended, and why.
channelenum
The delivery channel for this endpoint.
Allowed values:
urlstring
The HTTPS URL event payloads are delivered to. Shown as a masked placeholder unless the request explicitly asks to reveal sensitive values.
has_authentication_tokenboolean
Whether a bearer authentication token is configured. The token is write-only and is never returned.
has_signing_secretboolean
Whether a signing secret is configured. The secret is returned only when created or rotated.
trigger_eventslist of stringsOptional
The events this endpoint is subscribed to.
filter_identifierslist of stringsOptional
The specific objects this endpoint's subscription is scoped to, if any. Empty means it receives events for every object.
