Stiddle API Documentation

Welcome to the Stiddle API — a simple and secure way to connect, track, and sync customer events and profiles from your applications, websites, or third-party integrations.

Our RESTful endpoints allow you to trigger events, send actions, and integrate seamlessly with automation tools such as Zapier or Make.

Base URL

https://api.stiddle.com/api/v1/

All endpoints use HTTPS. Non-secure HTTP requests are not supported.

Authentication

Each API request requires an API key to be included in the request headers or parameters. You can find your API key in your Stiddle dashboard under Settings → API Keys.

Header example:

X-API-KEY: your_api_key_here

Parameter example:

{
  "api_key": "your_api_key_here"
}

1. Trigger Event API

The Trigger Event endpoint retrieves data when a trigger (e.g. new customer profile creation) occurs within your connected app or workflow.

Endpoint

GET

https://api.stiddle.com/api/v1/zapier/trigger

Request Example

const options = {
  url: 'https://api.stiddle.com/api/v1/zapier/trigger',
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'X-API-KEY': bundle.authData.api_key
  },
  params: {
    'api_key': bundle.authData.api_key,
    'trigger': 'create_profile'
  }
}

Query Parameters

Parameter	Type	Required	Description
`api_key`	`string`	✅	Your unique Stiddle API key.
`trigger`	`string`	✅	Type of trigger to retrieve. Example: `create_profile`.

Response Example

[
  {
    "name": "Test",
    "id": "230cb499-a288-4dbe-8506-9400715aaae32",
    "email": "[email protected]",
    "first_name": "test",
    "last_name": "test",
    "uId": "003gL000006OLz7QAG",
    "contact_number": "(512) 754-6032",
    "_city": "None",
    "_state": "None",
    "_country": "None"
  }
]

Response Fields

Field	Type	Description
`name`	`string`	Full name of the profile.
`id`	`string`	Unique Stiddle profile ID.
`email`	`string`	Email address associated with the profile.
`first_name`	`string`	Profile’s first name.
`last_name`	`string`	Profile’s last name.
`uId`	`string`	CRM or external system ID.
`contact_number`	`string`	Phone number for the contact.
`_city`, `_state`, `_country`	`string`	Location data if available.

2. Send Event Action API

The Send Event Action endpoint allows you to push or log an event (such as a purchase, signup, or form submission) to Stiddle.

Endpoint

POST

https://api.stiddle.com/api/v1/zapier/action

Request Example

const options = {
  url: 'https://api.stiddle.com/api/v1/zapier/action',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  params: {
    'api_key': bundle.authData.api_key,
    'action': 'event'
  },
  body: {
    'event_type': bundle.inputData.event_type,
    'event_time': bundle.inputData.event_time || new Date().toISOString(),
    'page_url': bundle.inputData.page_url,
    'fingerprint': bundle.inputData.fingerprint,
    'uid': bundle.inputData.uid,
    'form_data': bundle.inputData.form_data,
    'first_name': bundle.inputData.first_name,
    'last_name': bundle.inputData.last_name,
    'email': bundle.inputData.email,
    'contact_number': bundle.inputData.contact_number,
    'ip': bundle.inputData.ip,
    'tags': bundle.inputData.tags,
    'id': bundle.inputData.id,
    'city': bundle.inputData.city,
    'state': bundle.inputData.state,
    'country': bundle.inputData.country,
    'postcode': bundle.inputData.postcode,
    'currency': bundle.inputData.currency,
    'order_id': bundle.inputData.order_id,
    'tax': bundle.inputData.tax,
    'price': bundle.inputData.price,
    'discount': bundle.inputData.discount,
    'shipping': bundle.inputData.shipping,
    'cogs': bundle.inputData.cogs,
    'quantity': bundle.inputData.quantity,
    'product_id': bundle.inputData.product_id,
    'product_name': bundle.inputData.product_name,
    'item_price': bundle.inputData.item_price,
    'item_discount': bundle.inputData.item_discount,
    'item_tax': bundle.inputData.item_tax
  },
  removeMissingValuesFrom: {
    'body': true,
    'params': true
  },
}

Parameters

Query Parameters

Parameter	Type	Required	Description
`api_key`	`string`	✅	Your Stiddle API key.
`action`	`string`	✅	Action type. Use `event` for sending event data.

Body Parameters

Parameter	Type	Required	Description
`event_type`	`string`	✅	The event name or type (e.g. `purchase`, `page_view`, `form_submit`).
`event_time`	`string`	❌	ISO-8601 timestamp of the event (defaults to current time).
`page_url`	`string`	❌	The page URL where the event occurred.
`fingerprint`	`string`	❌	Unique visitor identifier generated by Stiddle’s IRIS.
`uid`	`string`	❌	Unique user or customer ID.
`form_data`	`object`	❌	Any structured form data submitted.
`first_name`, `last_name`, `email`, `contact_number`	`string`	❌	Contact information fields.
`ip`, `tags`, `city`, `state`, `country`, `postcode`	`string`	❌	Additional metadata for analytics or segmentation.
`currency`, `order_id`, `tax`, `price`, `discount`, `shipping`, `cogs`	`number` / `string`	❌	Ecommerce-related fields.
`quantity`, `product_id`, `product_name`, `item_price`, `item_discount`, `item_tax`	`number` / `string`	❌	Product line-item details.

Success Response Example

{
  "status": "success",
  "message": "Event recorded successfully",
  "event_id": "4df59b03-2a7e-4f12-a7f0-9abf8b4a2b91",
  "timestamp": "2025-10-07T17:02:15.000Z"
}

Error Response Example

{
  "status": "error",
  "message": "Invalid API key or missing parameters."
}

Best Practices

Always send timestamps (event_time) in UTC using ISO-8601 format.
Sanitize and validate all input data before sending.
Handle rate limiting gracefully; retry with exponential backoff.
Store your api_key securely. Never expose it in public repositories.

Support

For API support, contact our developer team at 📧 [email protected] or visit help.stiddle.com.

Was this article helpful?

How to disconnect Google Ads Integration Completely?

Stiddle Zapier Connector