> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.notificacoesinteligentes.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Eventos da API

## Onde encontro os eventos da API?

Acesse nossa [documentação da API](https://docs.notificacoesinteligentes.com/) e, no canto inferior esquerdo, clique em **Eventos API**:

![](https://storage.crisp.chat/users/helpdesk/website/8b90f7361fe1a000/e67e9348-8aac-4e0c-a270-bd0590_1hmfrt3.png)

Em seguida, vão ser abertos todos os eventos da API:

![](https://storage.crisp.chat/users/helpdesk/website/1bebd929de5e8700/fc2189e5-779d-45d8-9255-d16ced_1hux2vc.png)

### Onde acho o payload dos eventos?

Após abrir todos os eventos, clique naquele que deseja:

![](https://storage.crisp.chat/users/helpdesk/website/a68265d446c8b800/e68cdb0d-0ae1-46a8-b125-7159ba_1e4s16t.png)

Agora, no canto direito da tela, é possível ver o **Payload** do evento:

![](https://storage.crisp.chat/users/helpdesk/website/684d533f99d77c00/28515291-0c1c-4827-b8fb-de870e_1burl12.png)

### Como utilizo o payload de cada evento?

O payload são os campos que o evento precisa. Como exemplo, vou utilizar o payload de **pedido pago**. Confira:

![](https://storage.crisp.chat/users/helpdesk/website/e53bb97dcd708800/ac5a592d-d930-480a-a045-1b9551_iotmx6.png)

Esse payload tem o campo **customer** e, dentro dele, existem vários campos então vai ficar assim:

||| No campo **customer[phone]** é necessário que deixe o seu telefone no formato [**E.164**](https://en.wikipedia.org/wiki/E.164): +5531999999999

*   customer[first_name];
*   customer[last_name];
*   customer[phone];
*   customer[email];
*   order[id];
*   order[products_total];
*   order[total];
*   order[discount];
*   order[products][0][name];
*   order[products][0][quantity];
*   order[products][0][value];
*   order[delivery][fee];
*   order[delivery][description].

O campo order[producsts][0] possui o **[0]** porque é um array. A regra segue para qualquer payload com array, como você vê abaixo:

![](https://storage.crisp.chat/users/helpdesk/website/fef9403406bd9800/1248aaf8-680b-4d46-a2bf-b6768e_1ih2at9.png)

Agora, o order[delivery] é um objeto:

![](https://storage.crisp.chat/users/helpdesk/website/de44d908b4f1d000/adc047a4-25b9-4828-9ce1-4718a9_wpj3ha.png)

## Onde encontro a URL de um evento?

Após escolher o evento que deseja, no canto superior direito da tela você vai encontrar a URL do evento:

![](https://storage.crisp.chat/users/helpdesk/website/622190e4c09ab000/c6ea4296-fe29-4d4f-8284-9c2163_1mfr3lg.png)

Você pode verificar o tipo do evento, como mostra a imagem:

![](https://storage.crisp.chat/users/helpdesk/website/1882d5cac22d3500/b4414106-8a55-42e8-9402-373135_ty7dvf.png)

Agora, clique nessa URL para conseguir copiar-lá:

![](https://storage.crisp.chat/users/helpdesk/website/ebc0b3d074493800/fc61a509-ec4c-42e3-9049-375a9a_ljtt0z.png)

### Como achar o ID da integração para colocar na URL?

Na URL do evento, existe um campo assim **{integrationId}**. Nele, vamos colocar o número da sua integração. Para isso, siga os passos abaixo.

Acesse a sua integração da API no [Notificações Inteligentes](https://app.notificacoesinteligentes.com/dashboard) e procure o campo **Como fazer a integração**:

![](https://storage.crisp.chat/users/helpdesk/website/13b6353cc4cfc300/59e544ec-bdf7-4db9-96de-3d80b8_1edo605.png)

Na URL, você consegue encontrar o número da sua integração:

![](https://storage.crisp.chat/users/helpdesk/website/aec5f47967454800/2ae3ab97-585b-41ed-b88c-6953e7_184miub.png)

Agora, vamos colocar esse número na **URL do evento** como no exemplo a seguir:

Essa é a **URL do evento de pedido pago**: https://api.notificacoesinteligentes.com/integrations/**{integrationId}**/events/order-paid.

No campo **{integrationId}**, vamos trocar o dado pelo número da sua integração. Então, vai ficar assim: https://api.notificacoesinteligentes.com/integrations/**493**/events/order-paid.

||| O número **493** é apenas de exemplo! Utilize o número da sua integração no lugar do 493, está bem?

## Onde ficam os Headers?

Após escolher o evento que deseja, você pode encontrar os **Headers**:

![](https://storage.crisp.chat/users/helpdesk/website/5366e80c98951400/65b0470b-8839-41d9-b9e7-3f1884_moqsjc.png)

## Como identifico a autorização do evento?

Após escolher o evento, você pode encontrar o tipo de autorização do evento. Aqui é utilizado o tipo **Bearer**:

![](https://storage.crisp.chat/users/helpdesk/website/a0dd847f8fa6380/d6e98885-839a-4604-8f76-6c99e5_5nq077.png)

Para saber qual a sua **token**, acesse sua conta do [Notificações Inteligentes](https://app.notificacoesinteligentes.com) e no canto superior direito, clique no **seu nome**:
![](https://storage.crisp.chat/users/helpdesk/website/786467ca5128f400/primeira-imagem_ipylpe.png)
Agora, clique em **Configurações**:

![](https://storage.crisp.chat/users/helpdesk/website/786467ca5128f400/primeira-segunda_14yy5gb.png)

Procure o campo **Chave de API**:

![](https://storage.crisp.chat/users/helpdesk/website/d395ca4750e2c800/19d78cec-1378-43a3-8883-a2f8b5_6l6re2.png)

Caso você não tenha uma chave da API, clique em **Gerar nova chave**:

![](https://storage.crisp.chat/users/helpdesk/website/214ab676d6674400/f1077fe2-658f-4548-a4a3-77f9b2_3hixrw.png)

Pronto! Essa é sua token.

Sempre que quiser saber qual a chave de autorização do evento, utilize o **tipo** + **token**:

*   Bearer d1r2a3g4o5n6b7a8l9l0z.