WebHookActivity interface
Activité webHook.
- Extends
Propriétés
| authentication | Méthode d’authentification utilisée pour appeler le point de terminaison. |
| body | Représente la charge utile qui sera envoyée au point de terminaison. Obligatoire pour la méthode POST/PUT, non autorisée pour le type de méthode GET : chaîne (ou expression avec chaîne resultType). |
| headers | Représente les en-têtes qui seront envoyés à la demande. Par exemple, pour définir la langue et le type sur une demande : « headers » : { « Accept-Language » : «en-us», « Content-Type » : « application/json » }. Type : chaîne (ou expression avec chaîne resultType). |
| method | Méthode API Rest pour le point de terminaison cible. |
| policy | Stratégie d’activité. |
| report |
Lorsque la valeur est true, statusCode, output et error dans le corps de la demande de rappel sont consommées par activité. L’activité peut être marquée comme ayant échoué en définissant statusCode >= 400 dans la demande de rappel. La valeur par défaut est false. Type : booléen (ou expression avec resultType booléen). |
| timeout | Délai d’expiration dans lequel le webhook doit être rappelé. S’il n’existe aucune valeur spécifiée, la valeur par défaut est de 10 minutes. Type : chaîne. Modèle : ((\d+).) ? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])). |
| type | Discriminateur polymorphe, qui spécifie les différents types que cet objet peut être |
| url | Point de terminaison et chemin cible de l’activité WebHook. Type : chaîne (ou expression avec chaîne resultType). |
Propriétés héritées
| depends |
L’activité dépend de la condition. |
| description | Description de l’activité. |
| name | Nom de l’activité. |
| on |
Résultat de l’état de l’activité lorsque l’état est défini sur Inactif. Il s’agit d’une propriété facultative et, si elle n’est pas fournie lorsque l’activité est inactive, l’état est réussi par défaut. |
| state | État de l’activité. Il s’agit d’une propriété facultative et, s’il n’est pas fourni, l’état est actif par défaut. |
| user |
Propriétés de l’utilisateur d’activité. |
Détails de la propriété
authentication
Méthode d’authentification utilisée pour appeler le point de terminaison.
authentication?: WebActivityAuthentication
Valeur de propriété
body
Représente la charge utile qui sera envoyée au point de terminaison. Obligatoire pour la méthode POST/PUT, non autorisée pour le type de méthode GET : chaîne (ou expression avec chaîne resultType).
body?: any
Valeur de propriété
any
headers
Représente les en-têtes qui seront envoyés à la demande. Par exemple, pour définir la langue et le type sur une demande : « headers » : { « Accept-Language » : «en-us», « Content-Type » : « application/json » }. Type : chaîne (ou expression avec chaîne resultType).
headers?: {[propertyName: string]: any}
Valeur de propriété
{[propertyName: string]: any}
method
Méthode API Rest pour le point de terminaison cible.
method: string
Valeur de propriété
string
policy
reportStatusOnCallBack
Lorsque la valeur est true, statusCode, output et error dans le corps de la demande de rappel sont consommées par activité. L’activité peut être marquée comme ayant échoué en définissant statusCode >= 400 dans la demande de rappel. La valeur par défaut est false. Type : booléen (ou expression avec resultType booléen).
reportStatusOnCallBack?: any
Valeur de propriété
any
timeout
Délai d’expiration dans lequel le webhook doit être rappelé. S’il n’existe aucune valeur spécifiée, la valeur par défaut est de 10 minutes. Type : chaîne. Modèle : ((\d+).) ? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
timeout?: string
Valeur de propriété
string
type
Discriminateur polymorphe, qui spécifie les différents types que cet objet peut être
type: "WebHook"
Valeur de propriété
"WebHook"
url
Point de terminaison et chemin cible de l’activité WebHook. Type : chaîne (ou expression avec chaîne resultType).
url: any
Valeur de propriété
any
Détails de la propriété héritée
dependsOn
L’activité dépend de la condition.
dependsOn?: ActivityDependency[]
Valeur de propriété
héritée deControlActivity.dependsOn
description
Description de l’activité.
description?: string
Valeur de propriété
string
héritée deControlActivity.description
name
onInactiveMarkAs
Résultat de l’état de l’activité lorsque l’état est défini sur Inactif. Il s’agit d’une propriété facultative et, si elle n’est pas fournie lorsque l’activité est inactive, l’état est réussi par défaut.
onInactiveMarkAs?: string
Valeur de propriété
string
héritée deControlActivity.onInactiveMarkAs
state
État de l’activité. Il s’agit d’une propriété facultative et, s’il n’est pas fourni, l’état est actif par défaut.
state?: string
Valeur de propriété
string
héritée deControlActivity.state
userProperties
Propriétés de l’utilisateur d’activité.
userProperties?: UserProperty[]
Valeur de propriété
héritée deControlActivity.userProperties