🚧
Work in Progress

Webhook Field Index

Field	Description	Appears in
accountId	Unique identifier for the account.	All account events
accountNumber	Account number associated with the account.	account.create
actionRequestor	Contains details about the source of the action (e.g., source: "api" or "internal"). Indicates if action was triggered by an API call or through another system like SST.	All events that weren't triggered by a provider
archiveReason	Reason for archiving a user.	user.archive
changeHistory	Array of objects describing changes made (field, oldValue, newValue).	account.featureUpdate, account.shippingAddressUpdate, account.statusUpdate, user.edit
companyId	The ID of the company associated with the webhook.	All events
cip	Customer Identification Program details. Only applicable if your program is using Spidr's KYC integration.	user.create
dateOfBirth	User's date of birth (in changeHistory).	user.edit
email	User's email (in changeHistory).	user.edit
field	Name of the field that was changed (in changeHistory).	account.featureUpdate, account.shippingAddressUpdate, account.statusUpdate, user.edit
firstName	User's first name (in changeHistory).	user.edit
id	Unique identifier for the user (in responseBody).	user.create
lastName	User's last name (in changeHistory).	user.edit
newStatus	New status after an account status update.	account.statusUpdate
newValue	New value of a changed field (in changeHistory).	account.featureUpdate, account.shippingAddressUpdate, account.statusUpdate, user.edit
oldValue	Previous value of a changed field (in changeHistory).	account.featureUpdate, account.shippingAddressUpdate, account.statusUpdate, user.edit
productId	Unique identifier for the product.	All events
providerDetails	Raw payload from the associated external provider (processor, etc.). Used for webhooks that are triggered via these external systems.	All events triggered by providers
requestId	Unique identifier for the request that triggered the webhook.	All events that weren't triggered by a provider
responseBody	Contains the full result of the API request that generated the webhook (if applicable). Processor-initiated webhooks (like card auths) will not have a 'responseBody.'	All events that weren't triggered by a provider
spidrActionId	A unique identifier for the action that was logged by Unified. For more details, see here .	All events that weren't triggered by a provider
statusReason	Reason for the status change.	account.statusUpdate
updated	Boolean indicating if an object was updated.	account.featureUpdate, user.edit, user.archive
userId	The ID of the user associated with the webhook event.	All events
uuid	Unique identifier for the webhook event.	All events
webhookType	The type of webhook event (e.g., user.archive, account.create).	All events
ztmData	Risk and risk provider object. Only applicable if your program is integrated with ZTM	All events that entail a ZTM risk check