# Automations

## Trigger automation via webhook (GET)

> \
> &#x20;       Triggers an automation using webhook data sent via GET request query parameters.\
> &#x20;       Query parameters are extracted using configured JSONPath extractors.\
> \
> &#x20;       Requires authentication via API key headers:\
> &#x20;       \- X-API-Key: Your API key\
> &#x20;       \- X-User-ID: Your user ID\
> &#x20;       \- X-Business-ID: Your business ID\
> &#x20;      &#x20;

```json
{"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"security":[{"businessId":[],"userId":[],"apiKey":[]}],"components":{"securitySchemes":{"businessId":{"type":"apiKey","in":"header","name":"X-BUSINESS-ID"}},"schemas":{"WebhookTriggerResponse":{"type":"object","properties":{"execution_id":{"type":"string","format":"uuid","nullable":true},"automation_id":{"type":"string","format":"uuid"}},"required":["automation_id","execution_id"]}}},"paths":{"/api/automations/{automation_identifier}/webhook/{webhook_name}":{"get":{"operationId":"trigger_webhook_get","description":"\n        Triggers an automation using webhook data sent via GET request query parameters.\n        Query parameters are extracted using configured JSONPath extractors.\n\n        Requires authentication via API key headers:\n        - X-API-Key: Your API key\n        - X-User-ID: Your user ID\n        - X-Business-ID: Your business ID\n        ","summary":"Trigger automation via webhook (GET)","parameters":[{"in":"path","name":"automation_identifier","schema":{"type":"string"},"required":true},{"in":"query","name":"record_email","schema":{"type":"string"},"description":"Record email for contact-based automations (query param or body)"},{"in":"query","name":"record_id","schema":{"type":"string"},"description":"Record UUID for record-based automations (query param or body)"},{"in":"query","name":"record_name","schema":{"type":"string"},"description":"Record name for custom object automations (query param or body)"},{"in":"path","name":"webhook_name","schema":{"type":"string"},"description":"The webhook name (must match trigger configuration)","required":true}],"tags":["automations"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTriggerResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""},"401":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""},"403":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""},"404":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""}}}}}}
```

## Trigger automation via webhook (POST)

> \
> &#x20;       Triggers an automation using webhook data sent via POST request.\
> &#x20;       Accepts arbitrary JSON/XML/form data and maps it to automation variables using JSONPath extractors.\
> \
> &#x20;       Requires authentication via API key headers:\
> &#x20;       \- X-API-Key: Your API key\
> &#x20;       \- X-User-ID: Your user ID\
> &#x20;       \- X-Business-ID: Your business ID\
> &#x20;      &#x20;

```json
{"openapi":"3.0.3","info":{"title":"Kizen API","version":"1.0.0"},"security":[{"businessId":[],"userId":[],"apiKey":[]}],"components":{"securitySchemes":{"businessId":{"type":"apiKey","in":"header","name":"X-BUSINESS-ID"}},"schemas":{"WebhookPayloadRequest":{"type":"object","properties":{"record_id":{"type":"string","format":"uuid","description":"Record UUID for record-based automations (fallback if not in query)"},"record_name":{"type":"string","minLength":1,"description":"Record name for custom object automations (fallback if not in query)"},"record_email":{"type":"string","format":"email","minLength":1,"description":"Record email for contact-based automations (fallback if not in query)"},"data":{"type":"object","additionalProperties":{},"description":"Arbitrary webhook payload data"}},"required":["data"]},"WebhookTriggerResponse":{"type":"object","properties":{"execution_id":{"type":"string","format":"uuid","nullable":true},"automation_id":{"type":"string","format":"uuid"}},"required":["automation_id","execution_id"]}}},"paths":{"/api/automations/{automation_identifier}/webhook/{webhook_name}":{"post":{"operationId":"trigger_webhook_post","description":"\n        Triggers an automation using webhook data sent via POST request.\n        Accepts arbitrary JSON/XML/form data and maps it to automation variables using JSONPath extractors.\n\n        Requires authentication via API key headers:\n        - X-API-Key: Your API key\n        - X-User-ID: Your user ID\n        - X-Business-ID: Your business ID\n        ","summary":"Trigger automation via webhook (POST)","parameters":[{"in":"path","name":"automation_identifier","schema":{"type":"string"},"required":true},{"in":"query","name":"record_email","schema":{"type":"string"},"description":"Record email for contact-based automations (query param or body)"},{"in":"query","name":"record_id","schema":{"type":"string"},"description":"Record UUID for record-based automations (query param or body)"},{"in":"query","name":"record_name","schema":{"type":"string"},"description":"Record name for custom object automations (query param or body)"},{"in":"path","name":"webhook_name","schema":{"type":"string"},"description":"The webhook name (must match trigger configuration)","required":true}],"tags":["automations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTriggerResponse"}}},"description":""},"400":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""},"401":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""},"403":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""},"404":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{},"description":"Unspecified response body"}}},"description":""}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.kizen.com/api/automations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
