Trigger API

The Trigger API allows you to create events. Each event is a representation of something that has happened and can include information about the event. Events are schemaless so you can include whatever JSON body you'd when creating a new event.

GET or POST Create an event

Create an event

Endpoint

https://trigger.kimiko.io/

HTTP Method

GET or POST

URI Parameters

Parameter	Type	Required	Description
source	string	No	The source of the event. This can be any string but it is used to identify where the event came from.
event	string	No	A description of the event.
workflow_id	string	No	Optional. If a workflow_id is included, the provided workflow will be explicitly executed. Use this if you for sure want to execute a particular workflow. If omitted, Kimiko will loop through your workflows to find which one (if any) to execute base on their workflow rules.
object_source	string	No	Optional. This optional parameter is useful for identifying an object coming from a CRM or other system
object_type	string	No	Optional. This optional parameter is useful for identifying an object coming from a CRM or other system
object_id	string	No	Optional. This optional parameter is useful for identifying an object coming from a CRM or other system

Body Parameters

Parameter	Type	Required	Description
*	object	No	Optional. You can include any JSON object in the request body.

Response

{
  "success": true,
  "id": "XXXX"
}

Trigger Event

A Trigger Event is logged whenever a valid request is sent to the Trigger API endpoint.

Data Model

Parameter	Type	Description
id	string	The id of the event.
event_type	string	The type of event (trigger, workflow-instance, or action).
source	string	The source included in the request URI
request	object	An object including the args, body, and header of the trigger request.
request.args	object	An object including a key value parir of the request uri parameters (excluding api keys.)
request.body	object	An object of the request body.
request.headers	object	An object of the request headers.
data	object	Any data enriched when the trigger is processed.
account_id	string	Kimiko account Id.
object_source	string?	Object source useful for identifying objects in CRM.
object_type	string?	Object type useful for identifying type of object in CRM.
object_id	string?	Object id useful for identifiying specific object in CRM.
kmk_version	float	The version of Kimiko that proccessed the event.
date_created	timestamp	The time the event was created.
date_updated	timestamp	The time the event was last updated.
found_workflow	boolean	Whether or not a workflow was found.
workflow_id	string?	The id of the workflow found.
event_id	string	Duplicate. The id of the event.

Example Trigger Event

{
    "id": "iKtPLazQ3j2n6shFIHW6",
    "event_type": "trigger",
    "source": "typeform", 
    "status": "processed",
    "request": {
        "args": {},
        "body": {},
        "headers": {}
    },
    "data": {}, 
    "account_id": "XXX", 
    "object_source": "typeform", 
    "object_type": null, 
    "object_id": null, 
    "kmk_version": 3,
    "date_created": "2022-12-23 21:33:22.303154+00:00",
    "date_updated": "2022-12-23 21:33:23.402699+00:00",
    "found_workflow": false, 
    "workflow_id": null, 
    "event_id": "iKtPLazQ3j2n6shFIHW6" 
}