Business Process Action Updated

wbhk

business_processes.actions.update

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

Receive real-time notifications when Business Process Actions are updated in your Account. This webhook enables you to synchronize your systems with action status changes, such as when steps complete or fail.

Info

The webhook payload contains the action ID and updated details. Use the Get Business Process Action 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 action status changes in your analytics platform.

Payload

string

required

The unique identifier of the action.

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 action.

businessProcess

string

required

The unique identifier of the business process associated with the action.

customer

string

required

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

type

string

enum

required

Specifies the type of business process action to be performed. Each action type represents a distinct step or operation within the business process, such as a payment or capture payment-method step.

status

string

enum

required

The current status of the action.

Allowed:

context

object

required

Provides additional contextual information relevant to the action. This can include any data or parameters that are necessary for executing the action within the given context. for more details on specific action context, refer to context section in action catalog, ex. approval-action.

features

object

required

Specifies additional features or attributes of the action. This field may include both required and optional settings or configurations that further detail how the action should be executed. for more details on specific action features, refer to features section in action catalog, ex. acknowledgement-action.

state

object

required

The state of the action, holding data that varies based on the action's status. Actions in-progress, resolved or failed actions may contain different information in their state. This property may not be fully populated and its data can change until the action is resolved or failed. for more details on specific action state, refer to state section in action catalog, ex. acknowledgement-action.

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.