Manipuladores de notificações

Recuperar todos

GET https://provasocialplus.com.br/api/notification-handlers/
curl --request GET \
--url 'https://provasocialplus.com.br/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
Parâmetros Detalhes Descrição
page Opcional Inteiro O número da página de onde você deseja obter os resultados. O valor padrão é 1.
results_per_page Opcional Inteiro Quantos resultados você deseja por página. Os valores permitidos são: 10 , 25 , 50 , 100 , 250 , 500 , 1000. O padrão é 25.
{ "data": [ { "id": 1, "type": "email", "name": "Work email", "settings": { "email": "hey@example.com" }, "is_enabled": true, "last_datetime": null, "datetime": "2021-06-27 22:16:23" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://provasocialplus.com.br/api/notification-handlers?&page=1", "last": "https://provasocialplus.com.br/api/notification-handlers?&page=1", "next": null, "prev": null, "self": "https://provasocialplus.com.br/api/notification-handlers?&page=1" } }

Recuperar um

GET https://provasocialplus.com.br/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://provasocialplus.com.br/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "type": "email", "name": "Work email", "settings": { "email": "hey@example.com" }, "is_enabled": true, "last_datetime": null, "datetime": "2021-06-27 22:16:23" } }

Criar

POST https://provasocialplus.com.br/api/notification-handlers
Parâmetros Detalhes Descrição
name Obrigatório String -
type Obrigatório String Valores permitidos:
email Opcional String Disponível quando: type = email Email
webhook Opcional String Disponível quando: type = webhook URL do webhook
slack Opcional String Disponível quando: type = slack URL do webhook do Slack
discord Opcional String Disponível quando: type = discord URL do webhook do Discord
telegram Opcional String Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional String Disponível quando: type = telegram ID do Chat do Telegram
curl --request POST \
--url 'https://provasocialplus.com.br/api/notification-handlers' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=email' \
--form 'email=hello@example.com' \
{ "data": { "id": 1 } }

Atualizar

POST https://provasocialplus.com.br/api/notification-handlers/{notification_handler_id}
Parâmetros Detalhes Descrição
name Opcional String -
type Opcional String Valores permitidos:
email Opcional String Disponível quando: type = email Email
webhook Opcional String Disponível quando: type = webhook URL do webhook
slack Opcional String Disponível quando: type = slack URL do webhook do Slack
discord Opcional String Disponível quando: type = discord URL do webhook do Discord
telegram Opcional String Disponível quando: type = telegram Token da API do Telegram
telegram_chat_id Opcional String Disponível quando: type = telegram ID do Chat do Telegram
is_enabled Opcional Boolean -
curl --request POST \
--url 'https://provasocialplus.com.br/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1' \
{ "data": { "id": 1 } }

Excluir

DELETE https://provasocialplus.com.br/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://provasocialplus.com.br/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \