Nodes & EdgesAdd node event

Add node event

Add an event to a node. Requires an agency key (ak_). Returns the created row.

curl -X POST "https://mythic-analytics.gulp.workers.dev/builder/canvases/123e4567-e89b-12d3-a456-426614174000/nodes/123e4567-e89b-12d3-a456-426614174000/events?location_id=acme-retail" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "platform": "mythic",
  "event_type": "Purchase",
  "trigger": "page_load",
  "trigger_config": {},
  "event_params": {},
  "platform_config_id": "123e4567-e89b-12d3-a456-426614174000",
  "enabled": true
}'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "node_id": "123e4567-e89b-12d3-a456-426614174000",
    "platform_config_id": "123e4567-e89b-12d3-a456-426614174000",
    "platform": "meta_pixel",
    "event_type": "Purchase",
    "trigger": "page_load",
    "trigger_config": {},
    "event_params": {},
    "journey_condition": {},
    "enabled": true,
    "template_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-12-25T10:00:00Z"
  }
}
POST
/canvases/{canvasId}/nodes/{nodeId}/events
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need canvases:read or canvases:write. See Using an mcp_ key over HTTP.

Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need canvases:read or canvases:write. See Using an mcp_ key over HTTP.
path
canvasIdstring
Required

Canvas UUID.

Format: uuid
path
nodeIdstring
Required

Canvas node UUID.

Format: uuid
query
location_idstring

Client location to scope the request to. Required when authenticating with an agency key (ak_). Ignored for viewer keys (sk_).

Content-Typestring
Required

The media type of the request body

Options: application/json
platformstring
Required
Options: mythic, meta_pixel, ga4, google_ads, tiktok, linkedin, pinterest, custom_html
triggerstring
Options: page_load, form_submit, button_click, scroll_depth, time_on_page, element_visible, custom
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need canvases:read or canvases:write. See Using an mcp_ key over HTTP.

Path Parameters

nodeIdstring
Required

Canvas node UUID.

Query Parameters

location_idstring

Client location to scope the request to. Required when authenticating with an agency key (ak_). Ignored for viewer keys (sk_).

Example:
acme-retail

Body

application/json
platformstring
Required
Allowed values:mythicmeta_pixelga4google_adstiktoklinkedinpinterestcustom_html
event_typestring
Required
Example:
Purchase
triggerstring
Allowed values:page_loadform_submitbutton_clickscroll_depthtime_on_pageelement_visiblecustom

Responses

dataobject