{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-alert-actions-put-request-schema.json",
"title": "alertActionsPutRequest",
"x-generated": "2026-09-21",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/payrix-alert-actions-api-openapi.yml#/components/schemas/alertActionsPutRequest",
"type": "object",
"properties": {
"alert": {
"type": "string",
"description": "The identifier of the Alert resource that defines this alertAction."
},
"headerName": {
"type": "string",
"description": "The request header name for authentication to the endpoint."
},
"headerValue": {
"type": "string",
"description": "The request header value for authentication to the endpoint."
},
"options": {
"type": "string",
"description": "When the 'type' field of this resource is set to 'web', this field determines the format that the Alert data should be sent in."
},
"value": {
"type": "string",
"description": "A value used to deliver the alert. Thie field should be set to an email address if the type is email, an endpoint if the type is web, etc."
},
"retries": {
"type": "integer",
"description": "The number of times an alert should be resent in case of a failure. This fields can only be set for web type alertActions.",
"contentEncoding": "int32"
},
"maxAttemptsTempDisabled": {
"allOf": [
{
"$ref": "#/$defs/alertActionsMaxAttemptsTempDisabled"
},
{
"description": "Whether it was temporarily disabled for reaching the maximum number of failed attempts.\n\n\nValid Values
\n\n- `0` - **Not Temporarily Disabled**\n- `1` - **Temporarily Disabled**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
},
"$defs": {
"alertActionsMaxAttemptsTempDisabled": {
"title": "alertActionsMaxAttemptsTempDisabled",
"enum": [
0,
1
],
"type": "integer"
},
"frozen": {
"title": "frozen",
"enum": [
0,
1
],
"type": "integer"
},
"inactive": {
"title": "inactive",
"enum": [
0,
1
],
"type": "integer"
}
}
}