WebHookActivity interface
Actividad de webHook.
- Extends
Propiedades
| authentication | Método de autenticación usado para llamar al punto de conexión. |
| body | Representa la carga que se enviará al punto de conexión. Obligatorio para el método POST/PUT, no permitido para el tipo de método GET: cadena (o Expresión con cadena resultType). |
| headers | Representa los encabezados que se enviarán a la solicitud. Por ejemplo, para establecer el idioma y el tipo en una solicitud: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadena (o Expresión con cadena resultType). |
| method | Método de API rest para el punto de conexión de destino. |
| policy | Directiva de actividad. |
| report |
Cuando se establece en true, statusCode, output y error en el cuerpo de la solicitud de devolución de llamada lo consumirá la actividad. La actividad se puede marcar como errónea estableciendo statusCode >= 400 en la solicitud de devolución de llamada. El valor predeterminado es false. Tipo: booleano (o Expression con resultType boolean). |
| timeout | Tiempo de espera en el que se debe llamar al webhook. Si no se especifica ningún valor, el valor predeterminado es de 10 minutos. Tipo: cadena. Patrón: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])). |
| type | Discriminador polimórfico, que especifica los distintos tipos que puede ser este objeto. |
| url | Punto de conexión y ruta de acceso de destino de la actividad de webHook. Tipo: cadena (o Expresión con cadena resultType). |
Propiedades heredadas
| depends |
La actividad depende de la condición. |
| description | Descripción de la actividad. |
| name | Nombre de la actividad. |
| on |
Resultado del estado de la actividad cuando el estado está establecido en Inactivo. Se trata de una propiedad opcional y, si no se proporciona cuando la actividad está inactiva, el estado será Correcto de forma predeterminada. |
| state | Estado de actividad. Se trata de una propiedad opcional y, si no se proporciona, el estado será Activo de forma predeterminada. |
| user |
Propiedades del usuario de actividad. |
Detalles de las propiedades
authentication
Método de autenticación usado para llamar al punto de conexión.
authentication?: WebActivityAuthentication
Valor de propiedad
body
Representa la carga que se enviará al punto de conexión. Obligatorio para el método POST/PUT, no permitido para el tipo de método GET: cadena (o Expresión con cadena resultType).
body?: any
Valor de propiedad
any
headers
Representa los encabezados que se enviarán a la solicitud. Por ejemplo, para establecer el idioma y el tipo en una solicitud: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadena (o Expresión con cadena resultType).
headers?: {[propertyName: string]: any}
Valor de propiedad
{[propertyName: string]: any}
method
Método de API rest para el punto de conexión de destino.
method: string
Valor de propiedad
string
policy
reportStatusOnCallBack
Cuando se establece en true, statusCode, output y error en el cuerpo de la solicitud de devolución de llamada lo consumirá la actividad. La actividad se puede marcar como errónea estableciendo statusCode >= 400 en la solicitud de devolución de llamada. El valor predeterminado es false. Tipo: booleano (o Expression con resultType boolean).
reportStatusOnCallBack?: any
Valor de propiedad
any
timeout
Tiempo de espera en el que se debe llamar al webhook. Si no se especifica ningún valor, el valor predeterminado es de 10 minutos. Tipo: cadena. Patrón: ((\d+).)? (\d\d):(60|( [0-5][0-9])):(60|( [0-5][0-9])).
timeout?: string
Valor de propiedad
string
type
Discriminador polimórfico, que especifica los distintos tipos que puede ser este objeto.
type: "WebHook"
Valor de propiedad
"WebHook"
url
Punto de conexión y ruta de acceso de destino de la actividad de webHook. Tipo: cadena (o Expresión con cadena resultType).
url: any
Valor de propiedad
any
Detalles de las propiedades heredadas
dependsOn
La actividad depende de la condición.
dependsOn?: ActivityDependency[]
Valor de propiedad
Heredado deControlActivity.dependsOn
description
Descripción de la actividad.
description?: string
Valor de propiedad
string
heredado deControlActivity.description
name
onInactiveMarkAs
Resultado del estado de la actividad cuando el estado está establecido en Inactivo. Se trata de una propiedad opcional y, si no se proporciona cuando la actividad está inactiva, el estado será Correcto de forma predeterminada.
onInactiveMarkAs?: string
Valor de propiedad
string
Heredado deControlActivity.onInactiveMarkAs
state
Estado de actividad. Se trata de una propiedad opcional y, si no se proporciona, el estado será Activo de forma predeterminada.
state?: string
Valor de propiedad
string
Heredado deControlActivity.state
userProperties
Propiedades del usuario de actividad.
userProperties?: UserProperty[]
Valor de propiedad
heredado deControlActivity.userProperties