Retrieve available dynamic variables

The available dynamic variables API allows you to retrieve a list of incident and alert fields that can be used as a variable within outbound messaging templates and workflows.

This endpoint will return all dynamic variables available for use in a webhook v2 integration configuration. This includes a list of standard system fields as well as any unique incident and alert tags created by your organization.

🚧 AI Processing delay
AI tags are generated at a 1-3 minute delay after initial incident processing. To include AI tags in static messages such as email, ensure the AutoShare is configured at a 3 minute delay.

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token. Your User API Key must be provided in the header, prefixed by the word Bearer.

Example:
Authorization: Bearer [YOUR_USER_API_KEY]

🚧 Only webhook v2 dynamic variables will be retrieved
Custom email templates have a different set of available variables than webhook v2 integrations. Fields retrieved by the Dynamic Variables API are explicitly for webhook v2 and may not be available for email templates. See our dynamic variables documentation for the list of fields available for email templates.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

application/json

List of valid fields retrieved successfully.
Variables can be added to paths, headers, and the payload body by framing the variable value with double brackets: {{variable.name}}.

Bodyapplication/json

{ "incident": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "incidentTags": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "primaryAlert.tags": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "primaryAlert": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "metadata": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "links": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "assignee": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "assigner": [ { "title": "custom_tag", "value": "category.custom_tag" } ], "additional_fields": [ { "title": "custom_tag", "value": "category.custom_tag" } ] }

Authentication

Request

Responses

Retrieve available dynamic variables

Authentication#

Request

Responses

Authentication