Workflow API

Dados via POST: enviar um array de nome dados com os dados abaixo:

evento*: Nome do evento criado no WorkFlow. Ex: "Novo Cadastro" ou "Trocar Senha";
nm_email: Endereço de e-mail do usuário que receberá a mensagem;
nm_celular: Celular do usuário que receberá o SMS. Deve ser obrigatóriamente preenchida no formato 551100000000.
nm_facebook: Id do usuário do Facebook que receberá a notificação.
nm_push: push id (push id é o identificador do device, ou seja, do aparelho do usuário que irá receber a notificação).
nm_plataforma: Informar se a plataforma é android ou ios.
vars: Objeto javascript com os valores que serão associados ao e-mail que será disparado;
vars_json: Deve passar um json com os dados para personalizar seu envio;
lista: Objeto javascript com as informações que serão adicionados em uma lista de e-mails. Este objeto é utilizado para realizar a integração automática com a ferramenta de e-mail.

  • Para ativá-lo o campo "nm_lista" é obrigatório. Aqui você deverá informar o nome da lista cadastrada onde os dados serão inseridos.
  • Nos exemplos abaixo o "atualizar" tem o valor 1, significa que os campos da lista devem ser atualizados caso o email ja exista.
  • Caso não queira que nenhum dos campos da lista sejam atualizados, basta marcar o "atualizar" logo abaixo do nome da lista como "0".
  • Outro parâmetro que pode ser usado dentro do Objeto lista é o "tipo", os valores aceitos são "Email" ou "SMS" ou "PUSH" e deverá ser informado caso a lista que está usando na TAG seja de SMS ou de PUSH, caso esse parâmetro não seja informado o valor assumido será EMAIL.

IMPORTANTE: Os parâmetros opcionais podem ser obrigatórios dependendo da regra criada no WorkFlow.

Se a regra enviar E-mail então o parâmetro nm_email será obrigatório.
Se a regra enviar E-mail e SMS então os parâmetros nm_email e nm_celular serão obrigatórios.
Se a regra enviar E-mail e a notificação Facebook então os parâmetros nm_email e nm_facebook serão obrigatórios.
Se a regra enviar Push então os parâmetros nm_push e nm_plataforma serão obrigatórios.
Se a regra enviar só SMS então só o parâmetro nm_celular será obrigatório.

{
                "evento" : "Novo Cadastro",
                "nm_email" : "[email protected]",
                "nm_celular" : "5511999998888",
                "vars" : { 
                          "nome" : "João"
                          },
                "vars_json" : {},
                "lista": { 
                          "nm_lista": "Nome da lista",
                          "atualizar" : "1",
                          "nome": "João",
                          "empresa": "Empresa",
                          "dt_cadastro" : {
                                        "valor" : "04/05/1989",
                                        "atualizar" : "0"
                                        }
                          }
                 }
Language
Click Try It! to start a request and see the response here!