---

title: "Destinations API Reference" description: "API reference for managing destinations and actions programmatically."

Destinations API

The Destinations API lets you create, manage, test, and delete outbound destinations.

Create a Destination

POST /api/integrations/destinations

Creates a new destination with one or more actions.

Request body

{
  "name": "Segment events",
  "type": "segment",
  "enabled": true,
  "credentials": {
    "write_key": "seg_..."
  },
  "actions": [
    {
      "name": "Send event",
      "action_type": "send_event",
      "enabled": true,
      "property_mapping": {
        "base": "default",
        "overrides": []
      },
      "event_filter": {
        "include": {
          "event_types": ["link.clicked", "link.qr_scanned"]
        },
        "exclude": {
          "bot_traffic": true
        },
        "conditions": []
      }
    }
  ]
}

List Destinations

GET /api/integrations/destinations

Returns configured destinations for the active workspace. Sensitive credentials are redacted in list responses.

Update a Destination

PUT /api/integrations/destinations/:id

Updates destination settings and replaces the destination's action list with the submitted actions.

Delete a Destination

DELETE /api/integrations/destinations/:id

Deletes the destination and its actions.

Send a Test Event

POST /api/integrations/destinations/:id/test-send

Queues a test event for one action on the destination.

Request body

{
  "action_id": "action_uuid"
}

If action_id is omitted, Nimriz uses the first enabled action on the destination.

Action types

Mapping actions

Each action can use these mapping override types:

• rename
• exclude
• include
• static
• template

Filters

Each action can filter on:

• include.event_types
• include.touch_types
• include.domain_ids
• include.tag_ids
• include.space_ids
• include.countries
• exclude.event_types
• exclude.touch_types
• exclude.domain_ids
• exclude.tag_ids
• exclude.countries
• exclude.bot_traffic
• conditions[]