Hub Transactional

The purpose of this document is to provide a guide for the correct use of the Masivian Hub Transactional API service, below you can see examples of the body of the request to start flows.

Request new flows

Endpoint generated to receive requests from new flows created on the Hub Transactional.

HTTP Method Endpoint
POST https://hub-transaccional.masivapp.com/api/hub-transaccional-model/flow/init-from-api

Start transactional flow

Request structure for new flows created from the graphical interface of Masiv Web. (https://masivapp.com/)

Parameters

Header Type Description
Authorization string Basic 64 authentication token which matches Basic username:password encoded in base 64
Body Type Description
dataToReplace array Collection of people in an array, which will enter the flow
flowId string Id representing the flow created from the web interface
Responses Description
🟢 200 Request successfully received

Example

{
    "status": "ok",
    "pTracking": "5fe25b29c33b9800109bb854"
}
Responses Description
🔴 500 The model ID does not match one created for the authenticated account

Example

{
    "status": "error",
    "response": "FLOW-SERVICE originalError:(model not found)"
}

Request structure example

NOTE: It must be taken into account that the objects inside the dataToReplace parameter correspond to the parameters configured from the web interface to start a transactional flow.

{
    "flowId": "5fe21261c33b980030933335",
    "dataToReplace": [
        {
            "name": "Carlos",
            "cellphone": "57301234567",
            "email": "[email protected]",            
            "age": 28,
            "message": "Hello this is a example"
        }
    ]
}

Request legacy flows