Skip to main content
Version: 4

Custom extensions appendix

This documentation page serves as a comprehensive reference for specialized custom extensions that can be incorporated into the application YAML file.

These extensions are tailored to meet specific needs and offer enhanced functionality beyond standard features. Developers can consult this resource to explore and comprehend the available custom extensions for advanced configuration and customization within the application YAML.

Extension: Post Account Actions​

This extension serves as a configuration for additional action to be performed after fetching the access token from the API.

Field name
Description
YAML
postAccountActionsThe list of actions to be performed<ch:codesample>

</ch:codesample>
type

The type of action being performed,

At present, only the "endpoint" action is available, indicating that an endpoint must be accessed to obtain additional data.

Possible Values: endpoint

<ch:codesample>

</ch:codesample>
operationId

The operationId refers to the unique identifier assigned to the endpoint that needs to be called.

 

<ch:codesample>

</ch:codesample>
persistParams

A list of parameters to be persisted that are obtained from the Endpoint action response.

  • name: The name of the parameter to be persisted.
  • value: The JSON path to extract the value for the above parameter from the response.
<ch:codesample>

</ch:codesample>

Example: Post Account action for Xero Application

Where,

  • postAccountActions: indicate that it deals with actions performed after an account-related operation.

  • - type: endpoint: Denotes that the following block of YAML describes an endpoint.

  • operationId: getTenantId: Specifies the unique identifier or operation ID for this action. In this case, it's named "getTenantId".

  • persistParams: Indicates parameters that should be persisted for subsequent requests within the same session.

    • - name: tenantId: Specifies the name of the parameter to be persisted, which is "tenantId".

    • value: $[0]['tenantId']: Defines the value of the "tenantId" parameter to be extracted from the first item ($[0]) of the incoming data and mapped to the "tenantId" parameter. This suggests that the endpoint expects some data where "tenantId" is a key, and it extracts this value to be used further in subsequent requests or actions.