Retrieve a variable usage

Returns the workflows that reference this environment variable via {{env.KEY}} in their step controls. variableId is required.

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

In: header

Path Parameters

variableIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

workflowsRequiredarray<object>

Array of workflows that reference this environment variable

export interface Response {
  /**
   * Array of workflows that reference this environment variable
   */
  workflows: EnvironmentVariableWorkflowInfoDto[];
}
export interface EnvironmentVariableWorkflowInfoDto {
  /**
   * The name of the workflow
   */
  name: string;
  /**
   * The unique identifier of the workflow
   */
  workflowId: string;
}

curl -X GET "https://api.novu.co/v1/environment-variables/string/usage" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "workflows": [
    {
      "name": "Welcome Email",
      "workflowId": "welcome-email"
    }
  ]
}

Authorization

Path Parameters

Header Parameters

Response Body

On this page