Gestionnaires de notifications
GET https://www.usershero.com/api/notification-handlers/
curl --request GET \
--url 'https://www.usershero.com/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.usershero.com/api/notification-handlers/' \
--header 'Authorization: Bearer {api_key}' \
| Paramètres | Détails | Description |
|---|---|---|
| page | Optionnel Entier | Le numéro de page à partir duquel vous souhaitez obtenir des résultats. Par défaut à 1. |
| results_per_page | Optionnel Entier | Combien de résultats souhaitez-vous par page. Les valeurs autorisées sont : 10 , 25 , 50 , 100 , 250 , 500 , 1000. Par défaut, 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://www.usershero.com/api/notification-handlers?&page=1",
"last": "https://www.usershero.com/api/notification-handlers?&page=1",
"next": null,
"prev": null,
"self": "https://www.usershero.com/api/notification-handlers?&page=1"
}
}
GET https://www.usershero.com/api/notification-handlers/{notification_handler_id}
curl --request GET \
--url 'https://www.usershero.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.usershero.com/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"
}
}
POST https://www.usershero.com/api/notification-handlers
| Paramètres | Détails | Description |
|---|---|---|
| name | Requis Chaîne | - |
| type | Requis Chaîne | Valeurs autorisées: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , push_subscriber_id |
| Optionnel Chaîne | Disponible lorsque : type = email Courriel | |
| webhook | Optionnel Chaîne | Disponible lorsque : type = webhook URL du webhook |
| slack | Optionnel Chaîne | Disponible lorsque : type = slack URL du webhook Slack |
| discord | Optionnel Chaîne | Disponible lorsque : type = discord URL du webhook Discord |
| telegram | Optionnel Chaîne | Disponible lorsque : type = telegram Jeton d'API Telegram |
| telegram_chat_id | Optionnel Chaîne | Disponible lorsque : type = telegram Identifiant de discussion Telegram |
| x_consumer_key | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| x_consumer_secret | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| x_access_token | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| x_access_token_secret | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| twilio | Optionnel Chaîne | Disponible lorsque : type = twilio Numéro de téléphone |
| twilio_call | Optionnel Chaîne | Disponible lorsque : type = twilio_call Numéro de téléphone |
| Optionnel Chaîne | Disponible lorsque : type = whatsapp Numéro de téléphone |
curl --request POST \
--url 'https://www.usershero.com/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://www.usershero.com/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://www.usershero.com/api/notification-handlers/{notification_handler_id}
| Paramètres | Détails | Description |
|---|---|---|
| name | Optionnel Chaîne | - |
| type | Optionnel Chaîne | Valeurs autorisées: email , webhook , slack , discord , telegram , microsoft_teams , twilio , twilio_call , whatsapp , push_subscriber_id |
| Optionnel Chaîne | Disponible lorsque : type = email Courriel | |
| webhook | Optionnel Chaîne | Disponible lorsque : type = webhook URL du webhook |
| slack | Optionnel Chaîne | Disponible lorsque : type = slack URL du webhook Slack |
| discord | Optionnel Chaîne | Disponible lorsque : type = discord URL du webhook Discord |
| telegram | Optionnel Chaîne | Disponible lorsque : type = telegram Jeton d'API Telegram |
| telegram_chat_id | Optionnel Chaîne | Disponible lorsque : type = telegram Identifiant de discussion Telegram |
| x_consumer_key | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| x_consumer_secret | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| x_access_token | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| x_access_token_secret | Optionnel Chaîne | Disponible lorsque : type = x Jeton d'API Telegram |
| twilio | Optionnel Chaîne | Disponible lorsque : type = twilio Numéro de téléphone |
| twilio_call | Optionnel Chaîne | Disponible lorsque : type = twilio_call Numéro de téléphone |
| Optionnel Chaîne | Disponible lorsque : type = whatsapp Numéro de téléphone | |
| is_enabled | Optionnel Booléen | - |
curl --request POST \
--url 'https://www.usershero.com/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://www.usershero.com/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://www.usershero.com/api/notification-handlers/{notification_handler_id}
curl --request DELETE \
--url 'https://www.usershero.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://www.usershero.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \