Automation Workflows

To Create a Workflow rule, Go to Settings -> Automation -> Workflow Rules

Click Create Rule Button

Follow Create New Rule Popup window will open.

Now,

  • Choose Module
  • Input a Rule Name & Description
  • Click Next
create a new rule

create a new rule

Choose Date/Time or event to execute the rule

Choose trigger

Choose trigger

Select condition.

select a condition

select a condition

Select action as Webhook

select action - webhook

select action - webhook

Webhook Configuration

Method: POST

URL To Notify: https://asia-south1-integrations-service-10ecc.cloudfunctions.net/wrapperServices/v1/pushmessage/

Authorization Type: General

Body

Type: Raw

Format: JSON

Click Save.

New Rule will show in Workflow Rules. Make sure status is ON.

Payload Parameters

Parameter NameDescription
tokenThis is a token which you will get from extension setting page.
dataIt will have array of message objects
send_toThe contact no. where you have to send the messages.
messageString message.
mediaURLPublic Media URL
mediaTypeimage

video

document
templateApproved template message.
template variablesArray, list of strings.
isSandBoxBoolean, For sending sandbox template.
headerheader string
footerfooter string

Note: If a message object has template & message both, then template attribute will have priority and template message will be sent.

How to generate/get Token

Token gets generated automatically during configuration save on Extension settings.

settings

settings

Note: If you are existing customer and don’t see the Webhook token yet on the setting page, resubmit the settings will generate new token.

Example Payloads

Single Message


{

    "token":"e79a4271-5002-49ae-89a6-145bd2d58206",
    "data":[
        {
        "send_to":"7974152243",
        "message":"Hello"
        }
    ]
}

Multiple Messages

{

    "token":"e79a4271-5002-49ae-89a6-145bd2d58206",
    "data":[
        {
        "send_to":"7974152243",
        "message":"Hello"
        },

        {
        "send_to":"7974152243",
        "message":"World"
        }
    ]
}

Media Messages

{
    "token":"e79a4271-5002-49ae-89a6-145bd2d58206",
    "data":[
        {
        "send_to":"7974152243",
        "mediaType":"image",
        "mediaURL" :"https://images.unsplash.com/photo-1617854818583-09e7f077a156?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1470&q=80"
        }
     ]
}

Header Footer Template Messages

{  
    "token":"df460542-981e-4e12-88ad-90d70b3b64f8",  
    "data":[  
          {  
         "send_to":"7974152243",  
         "footer":"Hurry up",  
        "header":"New offer",  
         "template":"Get 10% discount on this weekend"  
      }  
    ]  
}

Template Message

{

    "token":"e79a4271-5002-49ae-89a6-145bd2d58206",

    "data":\[

       {

        "send_to":"7974152243",

        "template":"Prepaid {{1}}\\nYour Plan is Test. Please subscribe\\nThanks",

        "templateVariables":["199"]

        }

    ]

}

Header Footer Template Messages

{  
    "token":"df460542-981e-4e12-88ad-90d70b3b64f8",  
    "data":[  
          {  
         "send_to":"7974152243",  
         "footer":"Hurry up",  
        "header":"New offer",  
         "template":"Get 10% discount on this weekend"  
      }  
    ]  
}