Pular para o conteúdo principal

Nova afiliação

Atributos

Esta é a descrição dos parâmetros enviados pelo webhook em resposta a determinado evento.

Nome do parâmetroDescriçãoFormato e tamanho suportado
eventTipo de evento. Possíveis valores
AFFILIATION_CREATED: Afiliação Criada
AFFILIATION_REQUESTED: Afiliação Solicitada
AFFILIATION_APPROVED: Afiliação Aprovada.
String até 255 caracteres
statusStatus da afiliação. Possíveis valores
approved: Afiliação Aprovada
pending: Afiliação Pendente.
String até 255 caracteres
from_auto_affiliationIndica se a afiliação foi criada automaticamente. Possíveis valores: 0 (Não foi criada automaticamente).Número inteiro
creator_nameNome do criador da afiliaçãoString até 255 caracteres
creator_emailEmail do criador da afiliaçãoString no formato de email
codeCódigo da afiliaçãoString até 255 caracteres
commission_percentagePorcentagem de comissãoNúmero inteiro entre 0 e 100
product_idIdentificador do produto associado à afiliaçãoNúmero inteiro com até 20 dígitos
product_nameNome do produto associado à afiliaçãoString até 255 caracteres
affiliate_idIdentificador do afiliadoNúmero inteiro com até 20 dígitos
nameNome do afiliadoString até 255 caracteres
emailEmail do afiliadoString no formato de email
phoneTelefone do afiliadoString contendo números e caracteres especiais
documentCPF do afiliadoString no formato de CPF
affiliation_dateData da afiliaçãoString no formato de data

Objeto de requisição

Segue um exemplo do objeto da requisição:
{
"event": "AFFILIATION_CREATED",
"status": "approved",
"from_auto_affiliation": 0,
"creator_name": "Nome do criador da afiliação",
"creator_email": "[email protected]",
"code": "AF79BE3C59",
"commission_percentage": 10,
"product_id": 48052,
"product_name": "Nome do produto",
"affiliate_id": 1212480,
"name": "Nome do afiliado",
"email": "[email protected]",
"phone": "258139121334567",
"document": "696.891.960-57",
"affiliation_date": "2023-12-01 00:00:00",
}