Business Process Updated

wbhk

business_processes.update

Your system will receive this payload when you create a Subscription with type `business_processes.update`

Receive real-time notifications when Business Processes are updated in your Account. This webhook enables you to synchronize your systems with business process status changes, such as when workflows complete or fail.

Info

The webhook payload contains the business process ID and updated details. Use the Get Business Process endpoint to retrieve complete information.

Warning

Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the redrive policy.

Common use cases include updating your workflow management system, triggering notifications, or logging business process status changes in your analytics platform.

Payload

string

required

The unique identifier v4 id of the business process.

blueprint

string

The blueprint's slugified unique identifier name within an account (merchant).

partner

string

required

The unique identifier of the partner account.

merchant

string

required

The unique identifier (AVID) of the merchant's account associated with the business process.

customer

string

required

The unique identifier of the customer within the account(merchant).

status

string

enum

required

The current status of the business process.

Allowed:

statusReason

string

enum

The reason for the current status of the business process.

Allowed:

expiration

string

required

The expiration date of the business process, in ISO date-time format. When the expiration occurs, the status of the business process is set to failed and the statusReason is updated to expired.

version

number

The version of the business process.

agentOf

string

The agent address associated with the business process.

createdOn

string

The date when the business process was closed.

actions

array of objects

required

A list of business process actions which represents a distinct steps within the business process. for more details please review actions page and [action-catalog][acknowledgement-action] section.

actions*

addresses

array of objects

required

Represents a collection of contact addresses associated with the customer. Each address object must adhere to specific formats,email or phone number.

addresses*

Response

200

Your system should return a 2xx status to indicate that the data was published successfully. Other statuses will be considered a failure and we will retry later. See the redrive page for more details.