Notificações

Criação de notificação para uma determinada ação da nossa plataforma

POST {url_base}/notifications/{type}

É importante entender que caso o seu sistema vá enviar alguma notificação para uma determinada ação da plataforma, isso deverá ser previamente alinhado com nosso time.

Portanto, a plataforma irá desprezar qualquer notificação que não esteja dentro dos tipos (parâmetro {type}) esperados e previamente registrados.

Os conteúdos das notificações deverão sempre ser enviados com a utilização de JSON (Content-Type application/json) no corpo das requisições (body).

Path Parameters

Name	Type	Description
type	String	Tipo único da notificação que está sendo enviada

Headers

Name	Type	Description
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default
X-Api-Key*	String	Chave de API criada através da plataforma

Request Body

Name	Type	Description
{}*	Object	Conteúdo da notificação que está sendo enviada

200: OK Notificação recebida com sucesso

201: Created Notificação recebida com sucesso

400: Bad Request Erro no recebimento da notificação

401: Unauthorized Acesso não autorizado

404: Not Found Notificação inválida