Autenticação

POST https://www.sellerpay.com.br/api/v1/webhook/novo

Cadastra webhook na loja

🔒 Limite de requisição: 5 requisições por minuto.

Descrição

Cadastra a url de webhook.
Obs.: Utilizar tokenAPI (Authorization: Bearer)

É aceito apenas uma url. Para alterar os dados do webhook basta efetuar novo POST.

Body

JSON
{
	"url": "",
	"tipoAutorizacao": "",
	"usuario": "",
	"senha": "",
	"token": "",
	"modulo": "webhook",
	"ciclo": true,
	"aplicativo": true,
	"pedido": true
}

Parâmetros de Entrada

Campo Descrição Tipo Tamanho Obrigatório
url url de recebimento do webhook. clique aqui para ver a documentação do recebimento do webhook string 500 sim
tipoAutorizacao Utilizar Basic ou Bearer string 20 não
usuario Nome do usuário quando tipoAutorizacao for Basic string 30 sim se tipoAutorizacao Basic
senha Senha quando tipoAutorizacao for Basic string 100 sim se tipoAutorizacao Basic
token Token quando tipoAutorizacao for Bearer string 100 sim se tipoAutorizacao Bearer
modulo Modulo do webhook aceito os termos: webhook ou fila.
Webhook: Quando um evento ocorrer no SellerPay, enviaremos uma notificação para seu sistema.
Fila: Quando um evento ocorrer adicionaremos na fila para que seu sistema possa consumir.
string 7 não - valor padrão é webhook
ciclo Para receber webhooks sobre novos ciclos . boolean não - valor padrão true
aplicativo Para receber registrar webhooks evento de desinstalação do aplicativo: delete. boolean não - valor padrão true
pedido Para receber webhooks sobre novos pedidos. boolean não - valor padrão true

Resposta de Sucesso

200 OK
{
    "mensagem": "sucesso"
}

Dados de Resposta

Campo Descrição Tipo Tamanho
mensagem mensagem de sucesso ou erro string 255

Resposta de Erro

400 Bad Request
{
    "mensagem": ""
}
Campo Descrição Tipo Tamanho
mensagem Mensagem de retorno.
Exemplo:
Json não informado
Loja não ativa
string 255