Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Webhooks Integration

Update a custom variable

Updates the endpoint with the name <CUSTOM_VARIABLE_NAME>.

put/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}

Path parameters

custom_variable_namestring required

The name of the custom variable.

Request body

is_secretboolean

Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload.

namestring

The name of the variable. It corresponds with <CUSTOM_VARIABLE_NAME>. It must only contains upper-case characters, integers or underscores.

valuestring

Value of the custom variable.

Example request

{
  "name": "CUSTOM_VARIABLE_NAME",
  "value": "CUSTOM_VARIABLE_VALUE"
}

Response

OK

is_secretboolean required

Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload.

namestring required

The name of the variable. It corresponds with <CUSTOM_VARIABLE_NAME>. It must only contains upper-case characters, integers or underscores.

valuestring

Value of the custom variable. It won't be returned if the variable is secret.

Example response

{
  "is_secret": true,
  "name": "CUSTOM_VARIABLE_NAME",
  "value": "CUSTOM_VARIABLE_VALUE"
}