Retrieve a route by address

Returns the route bound to <address>@<domain>. Use * as the address to retrieve the wildcard route for the domain.

Authorization

Authorization<token>

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

In: header

Path Parameters

domainRequiredstring

addressRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

_idRequiredstring

_domainIdRequiredstring

addressRequiredstring

agentIdstring

Internal id of the destination agent. Only present for agent routes.

typeRequiredstring

Value in: "agent" | "webhook"

_environmentIdRequiredstring

_organizationIdRequiredstring

createdAtRequiredstring

updatedAtRequiredstring

dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).

export interface Response {
  _id: string;
  _domainId: string;
  address: string;
  /**
   * Internal id of the destination agent. Only present for agent routes.
   */
  agentId?: string;
  type: "agent" | "webhook";
  _environmentId: string;
  _organizationId: string;
  createdAt: string;
  updatedAt: string;
  /**
   * String key-value metadata (max 10 keys, 500 characters total when set via API).
   */
  data?: {
    [k: string]: string;
  };
}

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

{
  "_id": "string",
  "_domainId": "string",
  "address": "string",
  "agentId": "string",
  "type": "agent",
  "_environmentId": "string",
  "_organizationId": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Authorization

Path Parameters

Header Parameters

Response Body

On this page