Webhooks
GET https://staging.gratisqrcode.nl/api/notification-handlers/
curl --request GET \
--url 'https://staging.gratisqrcode.nl/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://staging.gratisqrcode.nl/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| search | Opcional Cordas | A cadeia de pesquisa. |
| search_by | Opcional Cordas | Que campo está a procurar? Os valores permitidos são: name. |
| is_enabled | Opcional Booleano | |
| type | Opcional Cordas | Que campo está a procurar? Os valores permitidos são: email, webhook, slack, discord, telegram, microsoft_teams. |
| datetime_field | Opcional Cordas | Valores permitidos: datetime, last_datetime |
| datetime_start | Opcional Cordas | Filtrar os resultados a partir desta data e hora. Formato Y-m-d H:i:s. |
| datetime_end | Opcional Cordas | Filtrar os resultados até esta data e hora. Formato Y-m-d H:i:s. |
| order_by | Opcional Cordas | Em que campo os resultados devem ser classificados. Os valores permitidos são: notification_handler_id, datetime, last_datetime, name. |
| order_type | Opcional Cordas | A ordem dos resultados. Os valores permitidos são: ASC para ordem crescente, e DESC para ordem decrescente. |
| search | Opcional Cordas | A cadeia de pesquisa. |
| search_by | Opcional Cordas | Que campo está a procurar? Os valores permitidos são: name. |
| is_enabled | Opcional Booleano | |
| type | Opcional Cordas | Que campo está a procurar? Os valores permitidos são: email, webhook, slack, discord, telegram, microsoft_teams. |
| datetime_field | Opcional Cordas | Valores permitidos: datetime, last_datetime |
| datetime_start | Opcional Cordas | Filtrar os resultados a partir desta data e hora. Formato Y-m-d H:i:s. |
| datetime_end | Opcional Cordas | Filtrar os resultados até esta data e hora. Formato Y-m-d H:i:s. |
| order_by | Opcional Cordas | Em que campo os resultados devem ser classificados. Os valores permitidos são: notification_handler_id, datetime, last_datetime, name. |
| order_type | Opcional Cordas | A ordem dos resultados. Os valores permitidos são: ASC para ordem crescente, e DESC para ordem decrescente. |
| page | Opcional Inteiro | O número da página a partir da qual você deseja obter resultados. Por padrão 1. |
| results_per_page | Opcional Inteiro | Quantos resultados pretende obter 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": "2026-06-17 19:51:38",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://staging.gratisqrcode.nl/api/notification-handlers?page=1",
"last": "https://staging.gratisqrcode.nl/api/notification-handlers?page=1",
"next": null,
"prev": null,
"self": "https://staging.gratisqrcode.nl/api/notification-handlers?page=1"
}
}
GET https://staging.gratisqrcode.nl/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://staging.gratisqrcode.nl/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://staging.gratisqrcode.nl/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": "2026-06-17 19:51:38",
}
}
POST https://staging.gratisqrcode.nl/api/notification-handlers
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| name | Necessário Cordas | - |
| type | Necessário Cordas | Valores permitidos: email, webhook, slack, discord, telegram, microsoft_teams |
| Opcional Cordas | Disponível quando: type = email Correio eletrónico | |
| webhook | Opcional Cordas | Disponível quando: type = webhook URL do webhook |
| slack | Opcional Cordas | Disponível quando: type = slack URL do webhook do Slack |
| discord | Opcional Cordas | Disponível quando: type = discord URL do webhook do Discord |
| telegram | Opcional Cordas | Disponível quando: type = telegram Token da API do Telegram |
| telegram_chat_id | Opcional Cordas | Disponível quando: type = telegram ID do chat do Telegram |
| microsoft_teams | Opcional Cordas | Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams |
curl --request POST \
--url 'https://staging.gratisqrcode.nl/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' \
--url 'https://staging.gratisqrcode.nl/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
}
}
POST https://staging.gratisqrcode.nl/api/notification-handlers/{notification_handler_id}
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| name | Opcional Cordas | - |
| type | Opcional Cordas | Valores permitidos: email, webhook, slack, discord, telegram, microsoft_teams |
| Opcional Cordas | Disponível quando: type = email Correio eletrónico | |
| webhook | Opcional Cordas | Disponível quando: type = webhook URL do webhook |
| slack | Opcional Cordas | Disponível quando: type = slack URL do webhook do Slack |
| discord | Opcional Cordas | Disponível quando: type = discord URL do webhook do Discord |
| telegram | Opcional Cordas | Disponível quando: type = telegram Token da API do Telegram |
| telegram_chat_id | Opcional Cordas | Disponível quando: type = telegram ID do chat do Telegram |
| microsoft_teams | Opcional Cordas | Disponível quando: type = microsoft_teams URL do webhook do Microsoft Teams |
| is_enabled | Opcional Booleano | - |
curl --request POST \
--url 'https://staging.gratisqrcode.nl/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' \
--url 'https://staging.gratisqrcode.nl/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
}
}
DELETE https://staging.gratisqrcode.nl/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://staging.gratisqrcode.nl/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://staging.gratisqrcode.nl/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \