KosmoKrator

productivity

Crisp Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Crisp KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.crisp.*. Use lua_read_doc("integrations.crisp") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Crisp workflow without starting an interactive agent session.

Inline Lua call
kosmo integrations:lua --eval 'dump(app.integrations.crisp.generate_bucket_url({}))' --json
Read Lua docs headlessly
kosmo integrations:lua --eval 'print(docs.read("crisp"))' --json
kosmo integrations:lua --eval 'print(docs.read("crisp.generate_bucket_url"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua
local crisp = app.integrations.crisp
local result = crisp.generate_bucket_url({})

dump(result)
Run the workflow
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.crisp, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.crisp.default.* or app.integrations.crisp.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Crisp, use the narrower mcp:lua command.

MCP Lua command
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Crisp Lua API Reference

Namespace: app.integrations.crisp

This integration exposes the official Crisp REST API method surface from node-crisp-api 10.9.3. Configure it with a token identifier, token key, token tier, and optionally a default website ID.

Usage Pattern

local conversations = app.integrations.crisp.list_conversations({
  page_number = 1,
  query = { per_page = 50 }
})

Website-scoped tools accept website_id; if omitted, the configured default website ID is used. Complex write requests should pass the Crisp-documented JSON body as payload.

Operation Coverage

Total tools: 226

| crisp_generate_bucket_url | write | POST /v1/bucket/url/generate | | crisp_list_animation_medias | read | GET /v1/media/animation/list/{pageNumber} | | crisp_plan_subscription_list_all_active_subscriptions | read | GET /v1/plans/subscription | | crisp_get_plan_subscription_for_website | read | GET /v1/plans/subscription/{websiteID} | | crisp_subscribe_website_to_plan | write | POST /v1/plans/subscription/{websiteID} | | crisp_unsubscribe_plan_from_website | write | DELETE /v1/plans/subscription/{websiteID} | | crisp_change_bill_period_for_website_plan_subscription | write | PATCH /v1/plans/subscription/{websiteID}/bill/period | | crisp_check_coupon_availability_for_website_plan_subscription | read | GET /v1/plans/subscription/{websiteID}/coupon | | crisp_redeem_coupon_for_website_plan_subscription | write | PATCH /v1/plans/subscription/{websiteID}/coupon | | crisp_get_connect_account | read | GET /v1/plugin/connect/account | | crisp_check_connect_session_validity | read | HEAD /v1/plugin/connect/session | | crisp_list_all_connect_websites | read | GET /v1/plugin/connect/websites/all/{pageNumber} | | crisp_list_connect_websites_since | read | GET /v1/plugin/connect/websites/since | | crisp_get_connect_endpoints | read | GET /v1/plugin/connect/endpoints | | crisp_plugin_subscription_list_all_active_subscriptions | read | GET /v1/plugins/subscription | | crisp_list_subscriptions_for_website | read | GET /v1/plugins/subscription/{websiteID} | | crisp_get_subscription_details | read | GET /v1/plugins/subscription/{websiteID}/{pluginID} | | crisp_subscribe_website_to_plugin | write | POST /v1/plugins/subscription/{websiteID} | | crisp_unsubscribe_plugin_from_website | write | DELETE /v1/plugins/subscription/{websiteID}/{pluginID} | | crisp_get_subscription_settings | read | GET /v1/plugins/subscription/{websiteID}/{pluginID}/settings | | crisp_save_subscription_settings | write | PUT /v1/plugins/subscription/{websiteID}/{pluginID}/settings | | crisp_update_subscription_settings | write | PATCH /v1/plugins/subscription/{websiteID}/{pluginID}/settings | | crisp_get_plugin_usage_bills | read | GET /v1/plugins/subscription/{websiteID}/{pluginID}/bill/usage | | crisp_report_plugin_usage_to_bill | write | POST /v1/plugins/subscription/{websiteID}/{pluginID}/bill/usage | | crisp_get_plugin_attest_provenance | read | GET /v1/plugins/subscription/{websiteID}/{pluginID}/attest/provenance | | crisp_forward_plugin_payload_to_channel | write | POST /v1/plugins/subscription/{websiteID}/{pluginID}/channel | | crisp_dispatch_plugin_event | write | POST /v1/plugins/subscription/{websiteID}/{pluginID}/event | | crisp_generate_analytics | write | POST /v1/website/{websiteID}/analytics/generate | | crisp_get_website_availability_status | read | GET /v1/website/{websiteID}/availability/status | | crisp_list_website_operator_availabilities | read | GET /v1/website/{websiteID}/availability/operators | | crisp_check_website_exists | read | HEAD /v1/website | | crisp_create_website | write | POST /v1/website | | crisp_get_website | read | GET /v1/website/{websiteID} | | crisp_delete_website | write | DELETE /v1/website/{websiteID} | | crisp_abort_website_deletion | write | DELETE /v1/website/{websiteID}/expunge | | crisp_batch_resolve_conversations | write | PATCH /v1/website/{websiteID}/batch/resolve | | crisp_batch_read_conversations | write | PATCH /v1/website/{websiteID}/batch/read | | crisp_batch_remove_conversations | write | PATCH /v1/website/{websiteID}/batch/remove | | crisp_batch_remove_people | write | PATCH /v1/website/{websiteID}/batch/remove | | crisp_list_campaigns | read | GET /v1/website/{websiteID}/campaigns/list/{pageNumber} | | crisp_list_campaign_tags | read | GET /v1/website/{websiteID}/campaigns/tags | | crisp_list_campaign_templates | read | GET /v1/website/{websiteID}/campaigns/templates/{pageNumber} | | crisp_create_new_campaign_template | write | POST /v1/website/{websiteID}/campaigns/template | | crisp_check_campaign_template_exists | read | HEAD /v1/website/{websiteID}/campaigns/template/{templateID} | | crisp_get_campaign_template | read | GET /v1/website/{websiteID}/campaigns/template/{templateID} | | crisp_save_campaign_template | write | PUT /v1/website/{websiteID}/campaigns/template/{templateID} | | crisp_update_campaign_template | write | PATCH /v1/website/{websiteID}/campaigns/template/{templateID} | | crisp_remove_campaign_template | write | DELETE /v1/website/{websiteID}/campaigns/template/{templateID} | | crisp_create_new_campaign | write | POST /v1/website/{websiteID}/campaign | | crisp_check_campaign_exists | read | HEAD /v1/website/{websiteID}/campaign/{campaignID} | | crisp_get_campaign | read | GET /v1/website/{websiteID}/campaign/{campaignID} | | crisp_save_campaign | write | PUT /v1/website/{websiteID}/campaign/{campaignID} | | crisp_update_campaign | write | PATCH /v1/website/{websiteID}/campaign/{campaignID} | | crisp_remove_campaign | write | DELETE /v1/website/{websiteID}/campaign/{campaignID} | | crisp_dispatch_campaign | write | POST /v1/website/{websiteID}/campaign/{campaignID}/dispatch | | crisp_resume_campaign | write | POST /v1/website/{websiteID}/campaign/{campaignID}/resume | | crisp_pause_campaign | write | POST /v1/website/{websiteID}/campaign/{campaignID}/pause | | crisp_test_campaign | write | POST /v1/website/{websiteID}/campaign/{campaignID}/test | | crisp_list_campaign_recipients | read | GET /v1/website/{websiteID}/campaign/{campaignID}/recipients/{pageNumber} | | crisp_list_campaign_statistics | read | GET /v1/website/{websiteID}/campaign/{campaignID}/statistics/{action}/{pageNumber} | | crisp_list_conversations | read | GET /v1/website/{websiteID}/conversations/{pageNumber} | | crisp_list_suggested_conversation_segments | read | GET /v1/website/{websiteID}/conversations/suggest/segments/{pageNumber} | | crisp_delete_suggested_conversation_segment | write | DELETE /v1/website/{websiteID}/conversations/suggest/segment | | crisp_list_suggested_conversation_data_keys | read | GET /v1/website/{websiteID}/conversations/suggest/data/{pageNumber} | | crisp_delete_suggested_conversation_data_key | write | DELETE /v1/website/{websiteID}/conversations/suggest/data | | crisp_list_spam_conversations | read | GET /v1/website/{websiteID}/conversations/spams/{pageNumber} | | crisp_resolve_spam_conversation_content | read | GET /v1/website/{websiteID}/conversations/spam/{spamID}/content | | crisp_submit_spam_conversation_decision | write | POST /v1/website/{websiteID}/conversations/spam/{spamID}/decision | | crisp_create_new_conversation | write | POST /v1/website/{websiteID}/conversation | | crisp_check_conversation_exists | read | HEAD /v1/website/{websiteID}/conversation/{sessionID} | | crisp_get_conversation | read | GET /v1/website/{websiteID}/conversation/{sessionID} | | crisp_remove_conversation | write | DELETE /v1/website/{websiteID}/conversation/{sessionID} | | crisp_initiate_conversation_with_existing_session | write | POST /v1/website/{websiteID}/conversation/{sessionID}/initiate | | crisp_get_messages_in_conversation | read | GET /v1/website/{websiteID}/conversation/{sessionID}/messages | | crisp_send_message_in_conversation | write | POST /v1/website/{websiteID}/conversation/{sessionID}/message | | crisp_get_message_in_conversation | read | GET /v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint} | | crisp_update_message_in_conversation | write | PATCH /v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint} | | crisp_remove_message_in_conversation | write | DELETE /v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint} | | crisp_compose_message_in_conversation | write | PATCH /v1/website/{websiteID}/conversation/{sessionID}/compose | | crisp_mark_messages_read_in_conversation | write | PATCH /v1/website/{websiteID}/conversation/{sessionID}/read |

Examples

Send a message in a conversation

local result = app.integrations.crisp.send_message_in_conversation({
  session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881",
  payload = {
    type = "text",
    from = "operator",
    origin = "chat",
    content = "Hey there! Need help?"
  }
})

Get a people profile

local profile = app.integrations.crisp.get_people_profile({
  people_id = "people_123"
})

List helpdesk articles

local articles = app.integrations.crisp.list_helpdesk_locale_articles({
  locale = "en",
  page_number = 1
})

Notes

Crisp authorization depends on token tier and scopes. A tool can be present in this package but still return not_allowed if the configured token tier or scopes do not permit that endpoint.

Query object values are JSON-encoded to match node-crisp-api behavior.

Raw agent markdown
# Crisp Lua API Reference

Namespace: `app.integrations.crisp`

This integration exposes the official Crisp REST API method surface from `node-crisp-api` 10.9.3. Configure it with a token identifier, token key, token tier, and optionally a default website ID.

## Usage Pattern

```lua
local conversations = app.integrations.crisp.list_conversations({
  page_number = 1,
  query = { per_page = 50 }
})
```

Website-scoped tools accept `website_id`; if omitted, the configured default website ID is used. Complex write requests should pass the Crisp-documented JSON body as `payload`.

## Operation Coverage

Total tools: 226

| `crisp_generate_bucket_url` | write | POST `/v1/bucket/url/generate` |
| `crisp_list_animation_medias` | read | GET `/v1/media/animation/list/{pageNumber}` |
| `crisp_plan_subscription_list_all_active_subscriptions` | read | GET `/v1/plans/subscription` |
| `crisp_get_plan_subscription_for_website` | read | GET `/v1/plans/subscription/{websiteID}` |
| `crisp_subscribe_website_to_plan` | write | POST `/v1/plans/subscription/{websiteID}` |
| `crisp_unsubscribe_plan_from_website` | write | DELETE `/v1/plans/subscription/{websiteID}` |
| `crisp_change_bill_period_for_website_plan_subscription` | write | PATCH `/v1/plans/subscription/{websiteID}/bill/period` |
| `crisp_check_coupon_availability_for_website_plan_subscription` | read | GET `/v1/plans/subscription/{websiteID}/coupon` |
| `crisp_redeem_coupon_for_website_plan_subscription` | write | PATCH `/v1/plans/subscription/{websiteID}/coupon` |
| `crisp_get_connect_account` | read | GET `/v1/plugin/connect/account` |
| `crisp_check_connect_session_validity` | read | HEAD `/v1/plugin/connect/session` |
| `crisp_list_all_connect_websites` | read | GET `/v1/plugin/connect/websites/all/{pageNumber}` |
| `crisp_list_connect_websites_since` | read | GET `/v1/plugin/connect/websites/since` |
| `crisp_get_connect_endpoints` | read | GET `/v1/plugin/connect/endpoints` |
| `crisp_plugin_subscription_list_all_active_subscriptions` | read | GET `/v1/plugins/subscription` |
| `crisp_list_subscriptions_for_website` | read | GET `/v1/plugins/subscription/{websiteID}` |
| `crisp_get_subscription_details` | read | GET `/v1/plugins/subscription/{websiteID}/{pluginID}` |
| `crisp_subscribe_website_to_plugin` | write | POST `/v1/plugins/subscription/{websiteID}` |
| `crisp_unsubscribe_plugin_from_website` | write | DELETE `/v1/plugins/subscription/{websiteID}/{pluginID}` |
| `crisp_get_subscription_settings` | read | GET `/v1/plugins/subscription/{websiteID}/{pluginID}/settings` |
| `crisp_save_subscription_settings` | write | PUT `/v1/plugins/subscription/{websiteID}/{pluginID}/settings` |
| `crisp_update_subscription_settings` | write | PATCH `/v1/plugins/subscription/{websiteID}/{pluginID}/settings` |
| `crisp_get_plugin_usage_bills` | read | GET `/v1/plugins/subscription/{websiteID}/{pluginID}/bill/usage` |
| `crisp_report_plugin_usage_to_bill` | write | POST `/v1/plugins/subscription/{websiteID}/{pluginID}/bill/usage` |
| `crisp_get_plugin_attest_provenance` | read | GET `/v1/plugins/subscription/{websiteID}/{pluginID}/attest/provenance` |
| `crisp_forward_plugin_payload_to_channel` | write | POST `/v1/plugins/subscription/{websiteID}/{pluginID}/channel` |
| `crisp_dispatch_plugin_event` | write | POST `/v1/plugins/subscription/{websiteID}/{pluginID}/event` |
| `crisp_generate_analytics` | write | POST `/v1/website/{websiteID}/analytics/generate` |
| `crisp_get_website_availability_status` | read | GET `/v1/website/{websiteID}/availability/status` |
| `crisp_list_website_operator_availabilities` | read | GET `/v1/website/{websiteID}/availability/operators` |
| `crisp_check_website_exists` | read | HEAD `/v1/website` |
| `crisp_create_website` | write | POST `/v1/website` |
| `crisp_get_website` | read | GET `/v1/website/{websiteID}` |
| `crisp_delete_website` | write | DELETE `/v1/website/{websiteID}` |
| `crisp_abort_website_deletion` | write | DELETE `/v1/website/{websiteID}/expunge` |
| `crisp_batch_resolve_conversations` | write | PATCH `/v1/website/{websiteID}/batch/resolve` |
| `crisp_batch_read_conversations` | write | PATCH `/v1/website/{websiteID}/batch/read` |
| `crisp_batch_remove_conversations` | write | PATCH `/v1/website/{websiteID}/batch/remove` |
| `crisp_batch_remove_people` | write | PATCH `/v1/website/{websiteID}/batch/remove` |
| `crisp_list_campaigns` | read | GET `/v1/website/{websiteID}/campaigns/list/{pageNumber}` |
| `crisp_list_campaign_tags` | read | GET `/v1/website/{websiteID}/campaigns/tags` |
| `crisp_list_campaign_templates` | read | GET `/v1/website/{websiteID}/campaigns/templates/{pageNumber}` |
| `crisp_create_new_campaign_template` | write | POST `/v1/website/{websiteID}/campaigns/template` |
| `crisp_check_campaign_template_exists` | read | HEAD `/v1/website/{websiteID}/campaigns/template/{templateID}` |
| `crisp_get_campaign_template` | read | GET `/v1/website/{websiteID}/campaigns/template/{templateID}` |
| `crisp_save_campaign_template` | write | PUT `/v1/website/{websiteID}/campaigns/template/{templateID}` |
| `crisp_update_campaign_template` | write | PATCH `/v1/website/{websiteID}/campaigns/template/{templateID}` |
| `crisp_remove_campaign_template` | write | DELETE `/v1/website/{websiteID}/campaigns/template/{templateID}` |
| `crisp_create_new_campaign` | write | POST `/v1/website/{websiteID}/campaign` |
| `crisp_check_campaign_exists` | read | HEAD `/v1/website/{websiteID}/campaign/{campaignID}` |
| `crisp_get_campaign` | read | GET `/v1/website/{websiteID}/campaign/{campaignID}` |
| `crisp_save_campaign` | write | PUT `/v1/website/{websiteID}/campaign/{campaignID}` |
| `crisp_update_campaign` | write | PATCH `/v1/website/{websiteID}/campaign/{campaignID}` |
| `crisp_remove_campaign` | write | DELETE `/v1/website/{websiteID}/campaign/{campaignID}` |
| `crisp_dispatch_campaign` | write | POST `/v1/website/{websiteID}/campaign/{campaignID}/dispatch` |
| `crisp_resume_campaign` | write | POST `/v1/website/{websiteID}/campaign/{campaignID}/resume` |
| `crisp_pause_campaign` | write | POST `/v1/website/{websiteID}/campaign/{campaignID}/pause` |
| `crisp_test_campaign` | write | POST `/v1/website/{websiteID}/campaign/{campaignID}/test` |
| `crisp_list_campaign_recipients` | read | GET `/v1/website/{websiteID}/campaign/{campaignID}/recipients/{pageNumber}` |
| `crisp_list_campaign_statistics` | read | GET `/v1/website/{websiteID}/campaign/{campaignID}/statistics/{action}/{pageNumber}` |
| `crisp_list_conversations` | read | GET `/v1/website/{websiteID}/conversations/{pageNumber}` |
| `crisp_list_suggested_conversation_segments` | read | GET `/v1/website/{websiteID}/conversations/suggest/segments/{pageNumber}` |
| `crisp_delete_suggested_conversation_segment` | write | DELETE `/v1/website/{websiteID}/conversations/suggest/segment` |
| `crisp_list_suggested_conversation_data_keys` | read | GET `/v1/website/{websiteID}/conversations/suggest/data/{pageNumber}` |
| `crisp_delete_suggested_conversation_data_key` | write | DELETE `/v1/website/{websiteID}/conversations/suggest/data` |
| `crisp_list_spam_conversations` | read | GET `/v1/website/{websiteID}/conversations/spams/{pageNumber}` |
| `crisp_resolve_spam_conversation_content` | read | GET `/v1/website/{websiteID}/conversations/spam/{spamID}/content` |
| `crisp_submit_spam_conversation_decision` | write | POST `/v1/website/{websiteID}/conversations/spam/{spamID}/decision` |
| `crisp_create_new_conversation` | write | POST `/v1/website/{websiteID}/conversation` |
| `crisp_check_conversation_exists` | read | HEAD `/v1/website/{websiteID}/conversation/{sessionID}` |
| `crisp_get_conversation` | read | GET `/v1/website/{websiteID}/conversation/{sessionID}` |
| `crisp_remove_conversation` | write | DELETE `/v1/website/{websiteID}/conversation/{sessionID}` |
| `crisp_initiate_conversation_with_existing_session` | write | POST `/v1/website/{websiteID}/conversation/{sessionID}/initiate` |
| `crisp_get_messages_in_conversation` | read | GET `/v1/website/{websiteID}/conversation/{sessionID}/messages` |
| `crisp_send_message_in_conversation` | write | POST `/v1/website/{websiteID}/conversation/{sessionID}/message` |
| `crisp_get_message_in_conversation` | read | GET `/v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint}` |
| `crisp_update_message_in_conversation` | write | PATCH `/v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint}` |
| `crisp_remove_message_in_conversation` | write | DELETE `/v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint}` |
| `crisp_compose_message_in_conversation` | write | PATCH `/v1/website/{websiteID}/conversation/{sessionID}/compose` |
| `crisp_mark_messages_read_in_conversation` | write | PATCH `/v1/website/{websiteID}/conversation/{sessionID}/read` |

## Examples

### Send a message in a conversation

```lua
local result = app.integrations.crisp.send_message_in_conversation({
  session_id = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881",
  payload = {
    type = "text",
    from = "operator",
    origin = "chat",
    content = "Hey there! Need help?"
  }
})
```

### Get a people profile

```lua
local profile = app.integrations.crisp.get_people_profile({
  people_id = "people_123"
})
```

### List helpdesk articles

```lua
local articles = app.integrations.crisp.list_helpdesk_locale_articles({
  locale = "en",
  page_number = 1
})
```

## Notes

Crisp authorization depends on token tier and scopes. A tool can be present in this package but still return `not_allowed` if the configured token tier or scopes do not permit that endpoint.

Query object values are JSON-encoded to match `node-crisp-api` behavior.
Metadata-derived Lua example
local result = app.integrations.crisp.generate_bucket_url({})
print(result)

Functions

generate_bucket_url Write

Execute the official Crisp REST API method `generateBucketURL` from node-crisp-api. Official Crisp endpoint: POST /v1/bucket/url/generate.

Lua path
app.integrations.crisp.generate_bucket_url
Full name
crisp.crisp_generate_bucket_url
ParameterTypeRequiredDescription
No parameters.
list_animation_medias Read

Execute the official Crisp REST API method `listAnimationMedias` from node-crisp-api. Official Crisp endpoint: GET /v1/media/animation/list/{pageNumber}.

Lua path
app.integrations.crisp.list_animation_medias
Full name
crisp.crisp_list_animation_medias
ParameterTypeRequiredDescription
No parameters.
plan_subscription_list_all_active_subscriptions Read

Execute the official Crisp REST API method `listAllActiveSubscriptions` from node-crisp-api. Official Crisp endpoint: GET /v1/plans/subscription.

Lua path
app.integrations.crisp.plan_subscription_list_all_active_subscriptions
Full name
crisp.crisp_plan_subscription_list_all_active_subscriptions
ParameterTypeRequiredDescription
No parameters.
get_plan_subscription_website Read

Execute the official Crisp REST API method `getPlanSubscriptionForWebsite` from node-crisp-api. Official Crisp endpoint: GET /v1/plans/subscription/{websiteID}.

Lua path
app.integrations.crisp.get_plan_subscription_website
Full name
crisp.crisp_get_plan_subscription_for_website
ParameterTypeRequiredDescription
No parameters.
subscribe_website_plan Write

Execute the official Crisp REST API method `subscribeWebsiteToPlan` from node-crisp-api. Official Crisp endpoint: POST /v1/plans/subscription/{websiteID}.

Lua path
app.integrations.crisp.subscribe_website_plan
Full name
crisp.crisp_subscribe_website_to_plan
ParameterTypeRequiredDescription
No parameters.
unsubscribe_plan_from_website Write

Execute the official Crisp REST API method `unsubscribePlanFromWebsite` from node-crisp-api. Official Crisp endpoint: DELETE /v1/plans/subscription/{websiteID}.

Lua path
app.integrations.crisp.unsubscribe_plan_from_website
Full name
crisp.crisp_unsubscribe_plan_from_website
ParameterTypeRequiredDescription
No parameters.
change_bill_period_website_plan_subscription Write

Execute the official Crisp REST API method `changeBillPeriodForWebsitePlanSubscription` from node-crisp-api. Official Crisp endpoint: PATCH /v1/plans/subscription/{websiteID}/bill/period.

Lua path
app.integrations.crisp.change_bill_period_website_plan_subscription
Full name
crisp.crisp_change_bill_period_for_website_plan_subscription
ParameterTypeRequiredDescription
No parameters.
check_coupon_availability_website_plan_subscription Read

Execute the official Crisp REST API method `checkCouponAvailabilityForWebsitePlanSubscription` from node-crisp-api. Official Crisp endpoint: GET /v1/plans/subscription/{websiteID}/coupon.

Lua path
app.integrations.crisp.check_coupon_availability_website_plan_subscription
Full name
crisp.crisp_check_coupon_availability_for_website_plan_subscription
ParameterTypeRequiredDescription
No parameters.
redeem_coupon_website_plan_subscription Write

Execute the official Crisp REST API method `redeemCouponForWebsitePlanSubscription` from node-crisp-api. Official Crisp endpoint: PATCH /v1/plans/subscription/{websiteID}/coupon.

Lua path
app.integrations.crisp.redeem_coupon_website_plan_subscription
Full name
crisp.crisp_redeem_coupon_for_website_plan_subscription
ParameterTypeRequiredDescription
No parameters.
get_connect_account Read

Execute the official Crisp REST API method `getConnectAccount` from node-crisp-api. Official Crisp endpoint: GET /v1/plugin/connect/account.

Lua path
app.integrations.crisp.get_connect_account
Full name
crisp.crisp_get_connect_account
ParameterTypeRequiredDescription
No parameters.
check_connect_session_validity Read

Execute the official Crisp REST API method `checkConnectSessionValidity` from node-crisp-api. Official Crisp endpoint: HEAD /v1/plugin/connect/session.

Lua path
app.integrations.crisp.check_connect_session_validity
Full name
crisp.crisp_check_connect_session_validity
ParameterTypeRequiredDescription
No parameters.
list_all_connect_websites Read

Execute the official Crisp REST API method `listAllConnectWebsites` from node-crisp-api. Official Crisp endpoint: GET /v1/plugin/connect/websites/all/{pageNumber}.

Lua path
app.integrations.crisp.list_all_connect_websites
Full name
crisp.crisp_list_all_connect_websites
ParameterTypeRequiredDescription
No parameters.
list_connect_websites_since Read

Execute the official Crisp REST API method `listConnectWebsitesSince` from node-crisp-api. Official Crisp endpoint: GET /v1/plugin/connect/websites/since.

Lua path
app.integrations.crisp.list_connect_websites_since
Full name
crisp.crisp_list_connect_websites_since
ParameterTypeRequiredDescription
No parameters.
get_connect_endpoints Read

Execute the official Crisp REST API method `getConnectEndpoints` from node-crisp-api. Official Crisp endpoint: GET /v1/plugin/connect/endpoints.

Lua path
app.integrations.crisp.get_connect_endpoints
Full name
crisp.crisp_get_connect_endpoints
ParameterTypeRequiredDescription
No parameters.
plugin_subscription_list_all_active_subscriptions Read

Execute the official Crisp REST API method `listAllActiveSubscriptions` from node-crisp-api. Official Crisp endpoint: GET /v1/plugins/subscription.

Lua path
app.integrations.crisp.plugin_subscription_list_all_active_subscriptions
Full name
crisp.crisp_plugin_subscription_list_all_active_subscriptions
ParameterTypeRequiredDescription
No parameters.
list_subscriptions_website Read

Execute the official Crisp REST API method `listSubscriptionsForWebsite` from node-crisp-api. Official Crisp endpoint: GET /v1/plugins/subscription/{websiteID}.

Lua path
app.integrations.crisp.list_subscriptions_website
Full name
crisp.crisp_list_subscriptions_for_website
ParameterTypeRequiredDescription
No parameters.
get_subscription_details Read

Execute the official Crisp REST API method `getSubscriptionDetails` from node-crisp-api. Official Crisp endpoint: GET /v1/plugins/subscription/{websiteID}/{pluginID}.

Lua path
app.integrations.crisp.get_subscription_details
Full name
crisp.crisp_get_subscription_details
ParameterTypeRequiredDescription
No parameters.
subscribe_website_plugin Write

Execute the official Crisp REST API method `subscribeWebsiteToPlugin` from node-crisp-api. Official Crisp endpoint: POST /v1/plugins/subscription/{websiteID}.

Lua path
app.integrations.crisp.subscribe_website_plugin
Full name
crisp.crisp_subscribe_website_to_plugin
ParameterTypeRequiredDescription
No parameters.
unsubscribe_plugin_from_website Write

Execute the official Crisp REST API method `unsubscribePluginFromWebsite` from node-crisp-api. Official Crisp endpoint: DELETE /v1/plugins/subscription/{websiteID}/{pluginID}.

Lua path
app.integrations.crisp.unsubscribe_plugin_from_website
Full name
crisp.crisp_unsubscribe_plugin_from_website
ParameterTypeRequiredDescription
No parameters.
get_subscription_settings Read

Execute the official Crisp REST API method `getSubscriptionSettings` from node-crisp-api. Official Crisp endpoint: GET /v1/plugins/subscription/{websiteID}/{pluginID}/settings.

Lua path
app.integrations.crisp.get_subscription_settings
Full name
crisp.crisp_get_subscription_settings
ParameterTypeRequiredDescription
No parameters.
save_subscription_settings Write

Execute the official Crisp REST API method `saveSubscriptionSettings` from node-crisp-api. Official Crisp endpoint: PUT /v1/plugins/subscription/{websiteID}/{pluginID}/settings.

Lua path
app.integrations.crisp.save_subscription_settings
Full name
crisp.crisp_save_subscription_settings
ParameterTypeRequiredDescription
No parameters.
update_subscription_settings Write

Execute the official Crisp REST API method `updateSubscriptionSettings` from node-crisp-api. Official Crisp endpoint: PATCH /v1/plugins/subscription/{websiteID}/{pluginID}/settings.

Lua path
app.integrations.crisp.update_subscription_settings
Full name
crisp.crisp_update_subscription_settings
ParameterTypeRequiredDescription
No parameters.
get_plugin_usage_bills Read

Execute the official Crisp REST API method `getPluginUsageBills` from node-crisp-api. Official Crisp endpoint: GET /v1/plugins/subscription/{websiteID}/{pluginID}/bill/usage.

Lua path
app.integrations.crisp.get_plugin_usage_bills
Full name
crisp.crisp_get_plugin_usage_bills
ParameterTypeRequiredDescription
No parameters.
report_plugin_usage_bill Write

Execute the official Crisp REST API method `reportPluginUsageToBill` from node-crisp-api. Official Crisp endpoint: POST /v1/plugins/subscription/{websiteID}/{pluginID}/bill/usage.

Lua path
app.integrations.crisp.report_plugin_usage_bill
Full name
crisp.crisp_report_plugin_usage_to_bill
ParameterTypeRequiredDescription
No parameters.
get_plugin_attest_provenance Read

Execute the official Crisp REST API method `getPluginAttestProvenance` from node-crisp-api. Official Crisp endpoint: GET /v1/plugins/subscription/{websiteID}/{pluginID}/attest/provenance.

Lua path
app.integrations.crisp.get_plugin_attest_provenance
Full name
crisp.crisp_get_plugin_attest_provenance
ParameterTypeRequiredDescription
No parameters.
forward_plugin_payload_channel Write

Execute the official Crisp REST API method `forwardPluginPayloadToChannel` from node-crisp-api. Official Crisp endpoint: POST /v1/plugins/subscription/{websiteID}/{pluginID}/channel.

Lua path
app.integrations.crisp.forward_plugin_payload_channel
Full name
crisp.crisp_forward_plugin_payload_to_channel
ParameterTypeRequiredDescription
No parameters.
dispatch_plugin_event Write

Execute the official Crisp REST API method `dispatchPluginEvent` from node-crisp-api. Official Crisp endpoint: POST /v1/plugins/subscription/{websiteID}/{pluginID}/event.

Lua path
app.integrations.crisp.dispatch_plugin_event
Full name
crisp.crisp_dispatch_plugin_event
ParameterTypeRequiredDescription
No parameters.
generate_analytics Write

Execute the official Crisp REST API method `generateAnalytics` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/analytics/generate.

Lua path
app.integrations.crisp.generate_analytics
Full name
crisp.crisp_generate_analytics
ParameterTypeRequiredDescription
No parameters.
get_website_availability_status Read

Execute the official Crisp REST API method `getWebsiteAvailabilityStatus` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/availability/status.

Lua path
app.integrations.crisp.get_website_availability_status
Full name
crisp.crisp_get_website_availability_status
ParameterTypeRequiredDescription
No parameters.
list_website_operator_availabilities Read

Execute the official Crisp REST API method `listWebsiteOperatorAvailabilities` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/availability/operators.

Lua path
app.integrations.crisp.list_website_operator_availabilities
Full name
crisp.crisp_list_website_operator_availabilities
ParameterTypeRequiredDescription
No parameters.
check_website_exists Read

Execute the official Crisp REST API method `checkWebsiteExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website.

Lua path
app.integrations.crisp.check_website_exists
Full name
crisp.crisp_check_website_exists
ParameterTypeRequiredDescription
No parameters.
create_website Write

Execute the official Crisp REST API method `createWebsite` from node-crisp-api. Official Crisp endpoint: POST /v1/website.

Lua path
app.integrations.crisp.create_website
Full name
crisp.crisp_create_website
ParameterTypeRequiredDescription
No parameters.
get_website Read

Execute the official Crisp REST API method `getWebsite` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}.

Lua path
app.integrations.crisp.get_website
Full name
crisp.crisp_get_website
ParameterTypeRequiredDescription
No parameters.
delete_website Write

Execute the official Crisp REST API method `deleteWebsite` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}.

Lua path
app.integrations.crisp.delete_website
Full name
crisp.crisp_delete_website
ParameterTypeRequiredDescription
No parameters.
abort_website_deletion Write

Execute the official Crisp REST API method `abortWebsiteDeletion` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/expunge.

Lua path
app.integrations.crisp.abort_website_deletion
Full name
crisp.crisp_abort_website_deletion
ParameterTypeRequiredDescription
No parameters.
batch_resolve_conversations Write

Execute the official Crisp REST API method `batchResolveConversations` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/batch/resolve.

Lua path
app.integrations.crisp.batch_resolve_conversations
Full name
crisp.crisp_batch_resolve_conversations
ParameterTypeRequiredDescription
No parameters.
batch_read_conversations Write

Execute the official Crisp REST API method `batchReadConversations` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/batch/read.

Lua path
app.integrations.crisp.batch_read_conversations
Full name
crisp.crisp_batch_read_conversations
ParameterTypeRequiredDescription
No parameters.
batch_remove_conversations Write

Execute the official Crisp REST API method `batchRemoveConversations` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/batch/remove.

Lua path
app.integrations.crisp.batch_remove_conversations
Full name
crisp.crisp_batch_remove_conversations
ParameterTypeRequiredDescription
No parameters.
batch_remove_people Write

Execute the official Crisp REST API method `batchRemovePeople` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/batch/remove.

Lua path
app.integrations.crisp.batch_remove_people
Full name
crisp.crisp_batch_remove_people
ParameterTypeRequiredDescription
No parameters.
list_campaigns Read

Execute the official Crisp REST API method `listCampaigns` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaigns/list/{pageNumber}.

Lua path
app.integrations.crisp.list_campaigns
Full name
crisp.crisp_list_campaigns
ParameterTypeRequiredDescription
No parameters.
list_campaign_tags Read

Execute the official Crisp REST API method `listCampaignTags` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaigns/tags.

Lua path
app.integrations.crisp.list_campaign_tags
Full name
crisp.crisp_list_campaign_tags
ParameterTypeRequiredDescription
No parameters.
list_campaign_templates Read

Execute the official Crisp REST API method `listCampaignTemplates` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaigns/templates/{pageNumber}.

Lua path
app.integrations.crisp.list_campaign_templates
Full name
crisp.crisp_list_campaign_templates
ParameterTypeRequiredDescription
No parameters.
create_new_campaign_template Write

Execute the official Crisp REST API method `createNewCampaignTemplate` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/campaigns/template.

Lua path
app.integrations.crisp.create_new_campaign_template
Full name
crisp.crisp_create_new_campaign_template
ParameterTypeRequiredDescription
No parameters.
check_campaign_template_exists Read

Execute the official Crisp REST API method `checkCampaignTemplateExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/campaigns/template/{templateID}.

Lua path
app.integrations.crisp.check_campaign_template_exists
Full name
crisp.crisp_check_campaign_template_exists
ParameterTypeRequiredDescription
No parameters.
get_campaign_template Read

Execute the official Crisp REST API method `getCampaignTemplate` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaigns/template/{templateID}.

Lua path
app.integrations.crisp.get_campaign_template
Full name
crisp.crisp_get_campaign_template
ParameterTypeRequiredDescription
No parameters.
save_campaign_template Write

Execute the official Crisp REST API method `saveCampaignTemplate` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/campaigns/template/{templateID}.

Lua path
app.integrations.crisp.save_campaign_template
Full name
crisp.crisp_save_campaign_template
ParameterTypeRequiredDescription
No parameters.
update_campaign_template Write

Execute the official Crisp REST API method `updateCampaignTemplate` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/campaigns/template/{templateID}.

Lua path
app.integrations.crisp.update_campaign_template
Full name
crisp.crisp_update_campaign_template
ParameterTypeRequiredDescription
No parameters.
remove_campaign_template Write

Execute the official Crisp REST API method `removeCampaignTemplate` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/campaigns/template/{templateID}.

Lua path
app.integrations.crisp.remove_campaign_template
Full name
crisp.crisp_remove_campaign_template
ParameterTypeRequiredDescription
No parameters.
create_new_campaign Write

Execute the official Crisp REST API method `createNewCampaign` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/campaign.

Lua path
app.integrations.crisp.create_new_campaign
Full name
crisp.crisp_create_new_campaign
ParameterTypeRequiredDescription
No parameters.
check_campaign_exists Read

Execute the official Crisp REST API method `checkCampaignExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/campaign/{campaignID}.

Lua path
app.integrations.crisp.check_campaign_exists
Full name
crisp.crisp_check_campaign_exists
ParameterTypeRequiredDescription
No parameters.
get_campaign Read

Execute the official Crisp REST API method `getCampaign` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaign/{campaignID}.

Lua path
app.integrations.crisp.get_campaign
Full name
crisp.crisp_get_campaign
ParameterTypeRequiredDescription
No parameters.
save_campaign Write

Execute the official Crisp REST API method `saveCampaign` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/campaign/{campaignID}.

Lua path
app.integrations.crisp.save_campaign
Full name
crisp.crisp_save_campaign
ParameterTypeRequiredDescription
No parameters.
update_campaign Write

Execute the official Crisp REST API method `updateCampaign` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/campaign/{campaignID}.

Lua path
app.integrations.crisp.update_campaign
Full name
crisp.crisp_update_campaign
ParameterTypeRequiredDescription
No parameters.
remove_campaign Write

Execute the official Crisp REST API method `removeCampaign` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/campaign/{campaignID}.

Lua path
app.integrations.crisp.remove_campaign
Full name
crisp.crisp_remove_campaign
ParameterTypeRequiredDescription
No parameters.
dispatch_campaign Write

Execute the official Crisp REST API method `dispatchCampaign` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/campaign/{campaignID}/dispatch.

Lua path
app.integrations.crisp.dispatch_campaign
Full name
crisp.crisp_dispatch_campaign
ParameterTypeRequiredDescription
No parameters.
resume_campaign Write

Execute the official Crisp REST API method `resumeCampaign` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/campaign/{campaignID}/resume.

Lua path
app.integrations.crisp.resume_campaign
Full name
crisp.crisp_resume_campaign
ParameterTypeRequiredDescription
No parameters.
pause_campaign Write

Execute the official Crisp REST API method `pauseCampaign` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/campaign/{campaignID}/pause.

Lua path
app.integrations.crisp.pause_campaign
Full name
crisp.crisp_pause_campaign
ParameterTypeRequiredDescription
No parameters.
test_campaign Write

Execute the official Crisp REST API method `testCampaign` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/campaign/{campaignID}/test.

Lua path
app.integrations.crisp.test_campaign
Full name
crisp.crisp_test_campaign
ParameterTypeRequiredDescription
No parameters.
list_campaign_recipients Read

Execute the official Crisp REST API method `listCampaignRecipients` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaign/{campaignID}/recipients/{pageNumber}.

Lua path
app.integrations.crisp.list_campaign_recipients
Full name
crisp.crisp_list_campaign_recipients
ParameterTypeRequiredDescription
No parameters.
list_campaign_statistics Read

Execute the official Crisp REST API method `listCampaignStatistics` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/campaign/{campaignID}/statistics/{action}/{pageNumber}.

Lua path
app.integrations.crisp.list_campaign_statistics
Full name
crisp.crisp_list_campaign_statistics
ParameterTypeRequiredDescription
No parameters.
list_conversations Read

Execute the official Crisp REST API method `listConversations` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversations/{pageNumber}.

Lua path
app.integrations.crisp.list_conversations
Full name
crisp.crisp_list_conversations
ParameterTypeRequiredDescription
No parameters.
list_suggested_conversation_segments Read

Execute the official Crisp REST API method `listSuggestedConversationSegments` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversations/suggest/segments/{pageNumber}.

Lua path
app.integrations.crisp.list_suggested_conversation_segments
Full name
crisp.crisp_list_suggested_conversation_segments
ParameterTypeRequiredDescription
No parameters.
delete_suggested_conversation_segment Write

Execute the official Crisp REST API method `deleteSuggestedConversationSegment` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/conversations/suggest/segment.

Lua path
app.integrations.crisp.delete_suggested_conversation_segment
Full name
crisp.crisp_delete_suggested_conversation_segment
ParameterTypeRequiredDescription
No parameters.
list_suggested_conversation_data_keys Read

Execute the official Crisp REST API method `listSuggestedConversationDataKeys` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversations/suggest/data/{pageNumber}.

Lua path
app.integrations.crisp.list_suggested_conversation_data_keys
Full name
crisp.crisp_list_suggested_conversation_data_keys
ParameterTypeRequiredDescription
No parameters.
delete_suggested_conversation_data_key Write

Execute the official Crisp REST API method `deleteSuggestedConversationDataKey` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/conversations/suggest/data.

Lua path
app.integrations.crisp.delete_suggested_conversation_data_key
Full name
crisp.crisp_delete_suggested_conversation_data_key
ParameterTypeRequiredDescription
No parameters.
list_spam_conversations Read

Execute the official Crisp REST API method `listSpamConversations` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversations/spams/{pageNumber}.

Lua path
app.integrations.crisp.list_spam_conversations
Full name
crisp.crisp_list_spam_conversations
ParameterTypeRequiredDescription
No parameters.
resolve_spam_conversation_content Read

Execute the official Crisp REST API method `resolveSpamConversationContent` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversations/spam/{spamID}/content.

Lua path
app.integrations.crisp.resolve_spam_conversation_content
Full name
crisp.crisp_resolve_spam_conversation_content
ParameterTypeRequiredDescription
No parameters.
submit_spam_conversation_decision Write

Execute the official Crisp REST API method `submitSpamConversationDecision` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversations/spam/{spamID}/decision.

Lua path
app.integrations.crisp.submit_spam_conversation_decision
Full name
crisp.crisp_submit_spam_conversation_decision
ParameterTypeRequiredDescription
No parameters.
create_new_conversation Write

Execute the official Crisp REST API method `createNewConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation.

Lua path
app.integrations.crisp.create_new_conversation
Full name
crisp.crisp_create_new_conversation
ParameterTypeRequiredDescription
No parameters.
check_conversation_exists Read

Execute the official Crisp REST API method `checkConversationExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/conversation/{sessionID}.

Lua path
app.integrations.crisp.check_conversation_exists
Full name
crisp.crisp_check_conversation_exists
ParameterTypeRequiredDescription
No parameters.
get_conversation Read

Execute the official Crisp REST API method `getConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}.

Lua path
app.integrations.crisp.get_conversation
Full name
crisp.crisp_get_conversation
ParameterTypeRequiredDescription
No parameters.
remove_conversation Write

Execute the official Crisp REST API method `removeConversation` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/conversation/{sessionID}.

Lua path
app.integrations.crisp.remove_conversation
Full name
crisp.crisp_remove_conversation
ParameterTypeRequiredDescription
No parameters.
initiate_conversation_with_existing_session Write

Execute the official Crisp REST API method `initiateConversationWithExistingSession` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/initiate.

Lua path
app.integrations.crisp.initiate_conversation_with_existing_session
Full name
crisp.crisp_initiate_conversation_with_existing_session
ParameterTypeRequiredDescription
No parameters.
get_messages_conversation Read

Execute the official Crisp REST API method `getMessagesInConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/messages.

Lua path
app.integrations.crisp.get_messages_conversation
Full name
crisp.crisp_get_messages_in_conversation
ParameterTypeRequiredDescription
No parameters.
send_message_conversation Write

Execute the official Crisp REST API method `sendMessageInConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/message.

Lua path
app.integrations.crisp.send_message_conversation
Full name
crisp.crisp_send_message_in_conversation
ParameterTypeRequiredDescription
No parameters.
get_message_conversation Read

Execute the official Crisp REST API method `getMessageInConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint}.

Lua path
app.integrations.crisp.get_message_conversation
Full name
crisp.crisp_get_message_in_conversation
ParameterTypeRequiredDescription
No parameters.
update_message_conversation Write

Execute the official Crisp REST API method `updateMessageInConversation` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint}.

Lua path
app.integrations.crisp.update_message_conversation
Full name
crisp.crisp_update_message_in_conversation
ParameterTypeRequiredDescription
No parameters.
remove_message_conversation Write

Execute the official Crisp REST API method `removeMessageInConversation` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/conversation/{sessionID}/message/{fingerprint}.

Lua path
app.integrations.crisp.remove_message_conversation
Full name
crisp.crisp_remove_message_in_conversation
ParameterTypeRequiredDescription
No parameters.
compose_message_conversation Write

Execute the official Crisp REST API method `composeMessageInConversation` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/compose.

Lua path
app.integrations.crisp.compose_message_conversation
Full name
crisp.crisp_compose_message_in_conversation
ParameterTypeRequiredDescription
No parameters.
mark_messages_read_conversation Write

Execute the official Crisp REST API method `markMessagesReadInConversation` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/read.

Lua path
app.integrations.crisp.mark_messages_read_conversation
Full name
crisp.crisp_mark_messages_read_in_conversation
ParameterTypeRequiredDescription
No parameters.
mark_conversation_as_unread Write

Execute the official Crisp REST API method `markConversationAsUnread` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/unread.

Lua path
app.integrations.crisp.mark_conversation_as_unread
Full name
crisp.crisp_mark_conversation_as_unread
ParameterTypeRequiredDescription
No parameters.
mark_messages_delivered_conversation Write

Execute the official Crisp REST API method `markMessagesDeliveredInConversation` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/delivered.

Lua path
app.integrations.crisp.mark_messages_delivered_conversation
Full name
crisp.crisp_mark_messages_delivered_in_conversation
ParameterTypeRequiredDescription
No parameters.
update_conversation_open_state Write

Execute the official Crisp REST API method `updateConversationOpenState` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/open.

Lua path
app.integrations.crisp.update_conversation_open_state
Full name
crisp.crisp_update_conversation_open_state
ParameterTypeRequiredDescription
No parameters.
get_conversation_routing_assign Read

Execute the official Crisp REST API method `getConversationRoutingAssign` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/routing.

Lua path
app.integrations.crisp.get_conversation_routing_assign
Full name
crisp.crisp_get_conversation_routing_assign
ParameterTypeRequiredDescription
No parameters.
assign_conversation_routing Write

Execute the official Crisp REST API method `assignConversationRouting` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/routing.

Lua path
app.integrations.crisp.assign_conversation_routing
Full name
crisp.crisp_assign_conversation_routing
ParameterTypeRequiredDescription
No parameters.
update_conversation_inbox Write

Execute the official Crisp REST API method `updateConversationInbox` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/inbox.

Lua path
app.integrations.crisp.update_conversation_inbox
Full name
crisp.crisp_update_conversation_inbox
ParameterTypeRequiredDescription
No parameters.
get_conversation_metas Read

Execute the official Crisp REST API method `getConversationMetas` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/meta.

Lua path
app.integrations.crisp.get_conversation_metas
Full name
crisp.crisp_get_conversation_metas
ParameterTypeRequiredDescription
No parameters.
update_conversation_metas Write

Execute the official Crisp REST API method `updateConversationMetas` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/meta.

Lua path
app.integrations.crisp.update_conversation_metas
Full name
crisp.crisp_update_conversation_metas
ParameterTypeRequiredDescription
No parameters.
get_original_message_conversation Read

Execute the official Crisp REST API method `getOriginalMessageInConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/original/{originalID}.

Lua path
app.integrations.crisp.get_original_message_conversation
Full name
crisp.crisp_get_original_message_in_conversation
ParameterTypeRequiredDescription
No parameters.
list_conversation_pages Read

Execute the official Crisp REST API method `listConversationPages` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/pages/{pageNumber}.

Lua path
app.integrations.crisp.list_conversation_pages
Full name
crisp.crisp_list_conversation_pages
ParameterTypeRequiredDescription
No parameters.
list_conversation_events Read

Execute the official Crisp REST API method `listConversationEvents` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/events/{pageNumber}.

Lua path
app.integrations.crisp.list_conversation_events
Full name
crisp.crisp_list_conversation_events
ParameterTypeRequiredDescription
No parameters.
list_conversation_files Read

Execute the official Crisp REST API method `listConversationFiles` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/files/{pageNumber}.

Lua path
app.integrations.crisp.list_conversation_files
Full name
crisp.crisp_list_conversation_files
ParameterTypeRequiredDescription
No parameters.
get_conversation_state Read

Execute the official Crisp REST API method `getConversationState` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/state.

Lua path
app.integrations.crisp.get_conversation_state
Full name
crisp.crisp_get_conversation_state
ParameterTypeRequiredDescription
No parameters.
change_conversation_state Write

Execute the official Crisp REST API method `changeConversationState` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/state.

Lua path
app.integrations.crisp.change_conversation_state
Full name
crisp.crisp_change_conversation_state
ParameterTypeRequiredDescription
No parameters.
get_conversation_relations Read

Execute the official Crisp REST API method `getConversationRelations` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/relations.

Lua path
app.integrations.crisp.get_conversation_relations
Full name
crisp.crisp_get_conversation_relations
ParameterTypeRequiredDescription
No parameters.
get_conversation_participants Read

Execute the official Crisp REST API method `getConversationParticipants` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/participants.

Lua path
app.integrations.crisp.get_conversation_participants
Full name
crisp.crisp_get_conversation_participants
ParameterTypeRequiredDescription
No parameters.
save_conversation_participants Write

Execute the official Crisp REST API method `saveConversationParticipants` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/conversation/{sessionID}/participants.

Lua path
app.integrations.crisp.save_conversation_participants
Full name
crisp.crisp_save_conversation_participants
ParameterTypeRequiredDescription
No parameters.
get_block_status_conversation Read

Execute the official Crisp REST API method `getBlockStatusForConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/block.

Lua path
app.integrations.crisp.get_block_status_conversation
Full name
crisp.crisp_get_block_status_for_conversation
ParameterTypeRequiredDescription
No parameters.
block_incoming_messages_conversation Write

Execute the official Crisp REST API method `blockIncomingMessagesForConversation` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/block.

Lua path
app.integrations.crisp.block_incoming_messages_conversation
Full name
crisp.crisp_block_incoming_messages_for_conversation
ParameterTypeRequiredDescription
No parameters.
get_verify_status_conversation Read

Execute the official Crisp REST API method `getVerifyStatusForConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/verify.

Lua path
app.integrations.crisp.get_verify_status_conversation
Full name
crisp.crisp_get_verify_status_for_conversation
ParameterTypeRequiredDescription
No parameters.
update_verify_status_conversation Write

Execute the official Crisp REST API method `updateVerifyStatusForConversation` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/verify.

Lua path
app.integrations.crisp.update_verify_status_conversation
Full name
crisp.crisp_update_verify_status_for_conversation
ParameterTypeRequiredDescription
No parameters.
request_identity_verification_conversation Write

Execute the official Crisp REST API method `requestIdentityVerificationForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/verify/identity.

Lua path
app.integrations.crisp.request_identity_verification_conversation
Full name
crisp.crisp_request_identity_verification_for_conversation
ParameterTypeRequiredDescription
No parameters.
request_email_transcript_conversation Write

Execute the official Crisp REST API method `requestEmailTranscriptForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/transcript.

Lua path
app.integrations.crisp.request_email_transcript_conversation
Full name
crisp.crisp_request_email_transcript_for_conversation
ParameterTypeRequiredDescription
No parameters.
request_chatbox_binding_purge_conversation Write

Execute the official Crisp REST API method `requestChatboxBindingPurgeForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/purge.

Lua path
app.integrations.crisp.request_chatbox_binding_purge_conversation
Full name
crisp.crisp_request_chatbox_binding_purge_for_conversation
ParameterTypeRequiredDescription
No parameters.
request_user_feedback_conversation Write

Execute the official Crisp REST API method `requestUserFeedbackForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/feedback.

Lua path
app.integrations.crisp.request_user_feedback_conversation
Full name
crisp.crisp_request_user_feedback_for_conversation
ParameterTypeRequiredDescription
No parameters.
list_browsing_sessions_conversation Read

Execute the official Crisp REST API method `listBrowsingSessionsForConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/browsing.

Lua path
app.integrations.crisp.list_browsing_sessions_conversation
Full name
crisp.crisp_list_browsing_sessions_for_conversation
ParameterTypeRequiredDescription
No parameters.
initiate_browsing_session_conversation Write

Execute the official Crisp REST API method `initiateBrowsingSessionForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/browsing.

Lua path
app.integrations.crisp.initiate_browsing_session_conversation
Full name
crisp.crisp_initiate_browsing_session_for_conversation
ParameterTypeRequiredDescription
No parameters.
send_action_existing_browsing_session Write

Execute the official Crisp REST API method `sendActionToExistingBrowsingSession` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/browsing/{browsingID}.

Lua path
app.integrations.crisp.send_action_existing_browsing_session
Full name
crisp.crisp_send_action_to_existing_browsing_session
ParameterTypeRequiredDescription
No parameters.
assist_existing_browsing_session Write

Execute the official Crisp REST API method `assistExistingBrowsingSession` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/browsing/{browsingID}/assist.

Lua path
app.integrations.crisp.assist_existing_browsing_session
Full name
crisp.crisp_assist_existing_browsing_session
ParameterTypeRequiredDescription
No parameters.
initiate_new_call_session_conversation Write

Execute the official Crisp REST API method `initiateNewCallSessionForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/call.

Lua path
app.integrations.crisp.initiate_new_call_session_conversation
Full name
crisp.crisp_initiate_new_call_session_for_conversation
ParameterTypeRequiredDescription
No parameters.
get_ongoing_call_session_conversation Read

Execute the official Crisp REST API method `getOngoingCallSessionForConversation` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/conversation/{sessionID}/call.

Lua path
app.integrations.crisp.get_ongoing_call_session_conversation
Full name
crisp.crisp_get_ongoing_call_session_for_conversation
ParameterTypeRequiredDescription
No parameters.
abort_ongoing_call_session_conversation Write

Execute the official Crisp REST API method `abortOngoingCallSessionForConversation` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/conversation/{sessionID}/call/{callID}.

Lua path
app.integrations.crisp.abort_ongoing_call_session_conversation
Full name
crisp.crisp_abort_ongoing_call_session_for_conversation
ParameterTypeRequiredDescription
No parameters.
transmit_signaling_ongoing_call_session Write

Execute the official Crisp REST API method `transmitSignalingOnOngoingCallSession` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/conversation/{sessionID}/call/{callID}.

Lua path
app.integrations.crisp.transmit_signaling_ongoing_call_session
Full name
crisp.crisp_transmit_signaling_on_ongoing_call_session
ParameterTypeRequiredDescription
No parameters.
deliver_widget_button_action_conversation Write

Execute the official Crisp REST API method `deliverWidgetButtonActionForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/widget/{pluginID}/button.

Lua path
app.integrations.crisp.deliver_widget_button_action_conversation
Full name
crisp.crisp_deliver_widget_button_action_for_conversation
ParameterTypeRequiredDescription
No parameters.
deliver_widget_data_fetch_action_conversation Write

Execute the official Crisp REST API method `deliverWidgetDataFetchActionForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/widget/{pluginID}/data.

Lua path
app.integrations.crisp.deliver_widget_data_fetch_action_conversation
Full name
crisp.crisp_deliver_widget_data_fetch_action_for_conversation
ParameterTypeRequiredDescription
No parameters.
deliver_widget_data_edit_action_conversation Write

Execute the official Crisp REST API method `deliverWidgetDataEditActionForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/widget/{pluginID}/data.

Lua path
app.integrations.crisp.deliver_widget_data_edit_action_conversation
Full name
crisp.crisp_deliver_widget_data_edit_action_for_conversation
ParameterTypeRequiredDescription
No parameters.
schedule_reminder_conversation Write

Execute the official Crisp REST API method `scheduleReminderForConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/reminder.

Lua path
app.integrations.crisp.schedule_reminder_conversation
Full name
crisp.crisp_schedule_reminder_for_conversation
ParameterTypeRequiredDescription
No parameters.
report_conversation Write

Execute the official Crisp REST API method `reportConversation` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/conversation/{sessionID}/report.

Lua path
app.integrations.crisp.report_conversation
Full name
crisp.crisp_report_conversation
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_exists Read

Execute the official Crisp REST API method `checkHelpdeskExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk.

Lua path
app.integrations.crisp.check_helpdesk_exists
Full name
crisp.crisp_check_helpdesk_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk Read

Execute the official Crisp REST API method `resolveHelpdesk` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk.

Lua path
app.integrations.crisp.resolve_helpdesk
Full name
crisp.crisp_resolve_helpdesk
ParameterTypeRequiredDescription
No parameters.
initialize_helpdesk Write

Execute the official Crisp REST API method `initializeHelpdesk` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk.

Lua path
app.integrations.crisp.initialize_helpdesk
Full name
crisp.crisp_initialize_helpdesk
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk Write

Execute the official Crisp REST API method `deleteHelpdesk` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk.

Lua path
app.integrations.crisp.delete_helpdesk
Full name
crisp.crisp_delete_helpdesk
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_locales Read

Execute the official Crisp REST API method `listHelpdeskLocales` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locales/{pageNumber}.

Lua path
app.integrations.crisp.list_helpdesk_locales
Full name
crisp.crisp_list_helpdesk_locales
ParameterTypeRequiredDescription
No parameters.
add_helpdesk_locale Write

Execute the official Crisp REST API method `addHelpdeskLocale` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale.

Lua path
app.integrations.crisp.add_helpdesk_locale
Full name
crisp.crisp_add_helpdesk_locale
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_locale_exists Read

Execute the official Crisp REST API method `checkHelpdeskLocaleExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk/locale/{locale}.

Lua path
app.integrations.crisp.check_helpdesk_locale_exists
Full name
crisp.crisp_check_helpdesk_locale_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale Read

Execute the official Crisp REST API method `resolveHelpdeskLocale` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}.

Lua path
app.integrations.crisp.resolve_helpdesk_locale
Full name
crisp.crisp_resolve_helpdesk_locale
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk_locale Write

Execute the official Crisp REST API method `deleteHelpdeskLocale` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk/locale/{locale}.

Lua path
app.integrations.crisp.delete_helpdesk_locale
Full name
crisp.crisp_delete_helpdesk_locale
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_locale_articles Read

Execute the official Crisp REST API method `listHelpdeskLocaleArticles` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/articles/{pageNumber}.

Lua path
app.integrations.crisp.list_helpdesk_locale_articles
Full name
crisp.crisp_list_helpdesk_locale_articles
ParameterTypeRequiredDescription
No parameters.
add_new_helpdesk_locale_article Write

Execute the official Crisp REST API method `addNewHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/article.

Lua path
app.integrations.crisp.add_new_helpdesk_locale_article
Full name
crisp.crisp_add_new_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_locale_article_exists Read

Execute the official Crisp REST API method `checkHelpdeskLocaleArticleExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}.

Lua path
app.integrations.crisp.check_helpdesk_locale_article_exists
Full name
crisp.crisp_check_helpdesk_locale_article_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale_article Read

Execute the official Crisp REST API method `resolveHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}.

Lua path
app.integrations.crisp.resolve_helpdesk_locale_article
Full name
crisp.crisp_resolve_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
save_helpdesk_locale_article Write

Execute the official Crisp REST API method `saveHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}.

Lua path
app.integrations.crisp.save_helpdesk_locale_article
Full name
crisp.crisp_save_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
update_helpdesk_locale_article Write

Execute the official Crisp REST API method `updateHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}.

Lua path
app.integrations.crisp.update_helpdesk_locale_article
Full name
crisp.crisp_update_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk_locale_article Write

Execute the official Crisp REST API method `deleteHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}.

Lua path
app.integrations.crisp.delete_helpdesk_locale_article
Full name
crisp.crisp_delete_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale_article_page Read

Execute the official Crisp REST API method `resolveHelpdeskLocaleArticlePage` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/page.

Lua path
app.integrations.crisp.resolve_helpdesk_locale_article_page
Full name
crisp.crisp_resolve_helpdesk_locale_article_page
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale_article_category Read

Execute the official Crisp REST API method `resolveHelpdeskLocaleArticleCategory` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/category.

Lua path
app.integrations.crisp.resolve_helpdesk_locale_article_category
Full name
crisp.crisp_resolve_helpdesk_locale_article_category
ParameterTypeRequiredDescription
No parameters.
update_helpdesk_locale_article_category Write

Execute the official Crisp REST API method `updateHelpdeskLocaleArticleCategory` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/category.

Lua path
app.integrations.crisp.update_helpdesk_locale_article_category
Full name
crisp.crisp_update_helpdesk_locale_article_category
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_locale_article_alternates Read

Execute the official Crisp REST API method `listHelpdeskLocaleArticleAlternates` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/alternates.

Lua path
app.integrations.crisp.list_helpdesk_locale_article_alternates
Full name
crisp.crisp_list_helpdesk_locale_article_alternates
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_locale_article_alternate_exists Read

Execute the official Crisp REST API method `checkHelpdeskLocaleArticleAlternateExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/alternate/{localeLinked}.

Lua path
app.integrations.crisp.check_helpdesk_locale_article_alternate_exists
Full name
crisp.crisp_check_helpdesk_locale_article_alternate_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale_article_alternate Read

Execute the official Crisp REST API method `resolveHelpdeskLocaleArticleAlternate` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/alternate/{localeLinked}.

Lua path
app.integrations.crisp.resolve_helpdesk_locale_article_alternate
Full name
crisp.crisp_resolve_helpdesk_locale_article_alternate
ParameterTypeRequiredDescription
No parameters.
save_helpdesk_locale_article_alternate Write

Execute the official Crisp REST API method `saveHelpdeskLocaleArticleAlternate` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/alternate/{localeLinked}.

Lua path
app.integrations.crisp.save_helpdesk_locale_article_alternate
Full name
crisp.crisp_save_helpdesk_locale_article_alternate
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk_locale_article_alternate Write

Execute the official Crisp REST API method `deleteHelpdeskLocaleArticleAlternate` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/alternate/{localeLinked}.

Lua path
app.integrations.crisp.delete_helpdesk_locale_article_alternate
Full name
crisp.crisp_delete_helpdesk_locale_article_alternate
ParameterTypeRequiredDescription
No parameters.
publish_helpdesk_locale_article Write

Execute the official Crisp REST API method `publishHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/publish.

Lua path
app.integrations.crisp.publish_helpdesk_locale_article
Full name
crisp.crisp_publish_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
unpublish_helpdesk_locale_article Write

Execute the official Crisp REST API method `unpublishHelpdeskLocaleArticle` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/article/{articleId}/unpublish.

Lua path
app.integrations.crisp.unpublish_helpdesk_locale_article
Full name
crisp.crisp_unpublish_helpdesk_locale_article
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_locale_categories Read

Execute the official Crisp REST API method `listHelpdeskLocaleCategories` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/categories/{pageNumber}.

Lua path
app.integrations.crisp.list_helpdesk_locale_categories
Full name
crisp.crisp_list_helpdesk_locale_categories
ParameterTypeRequiredDescription
No parameters.
add_helpdesk_locale_category Write

Execute the official Crisp REST API method `addHelpdeskLocaleCategory` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/category.

Lua path
app.integrations.crisp.add_helpdesk_locale_category
Full name
crisp.crisp_add_helpdesk_locale_category
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_locale_category_exists Read

Execute the official Crisp REST API method `checkHelpdeskLocaleCategoryExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}.

Lua path
app.integrations.crisp.check_helpdesk_locale_category_exists
Full name
crisp.crisp_check_helpdesk_locale_category_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale_category Read

Execute the official Crisp REST API method `resolveHelpdeskLocaleCategory` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}.

Lua path
app.integrations.crisp.resolve_helpdesk_locale_category
Full name
crisp.crisp_resolve_helpdesk_locale_category
ParameterTypeRequiredDescription
No parameters.
save_helpdesk_locale_category Write

Execute the official Crisp REST API method `saveHelpdeskLocaleCategory` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}.

Lua path
app.integrations.crisp.save_helpdesk_locale_category
Full name
crisp.crisp_save_helpdesk_locale_category
ParameterTypeRequiredDescription
No parameters.
update_helpdesk_locale_category Write

Execute the official Crisp REST API method `updateHelpdeskLocaleCategory` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}.

Lua path
app.integrations.crisp.update_helpdesk_locale_category
Full name
crisp.crisp_update_helpdesk_locale_category
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk_locale_category Write

Execute the official Crisp REST API method `deleteHelpdeskLocaleCategory` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}.

Lua path
app.integrations.crisp.delete_helpdesk_locale_category
Full name
crisp.crisp_delete_helpdesk_locale_category
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_locale_sections Read

Execute the official Crisp REST API method `listHelpdeskLocaleSections` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/sections/{pageNumber}.

Lua path
app.integrations.crisp.list_helpdesk_locale_sections
Full name
crisp.crisp_list_helpdesk_locale_sections
ParameterTypeRequiredDescription
No parameters.
add_helpdesk_locale_section Write

Execute the official Crisp REST API method `addHelpdeskLocaleSection` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/section.

Lua path
app.integrations.crisp.add_helpdesk_locale_section
Full name
crisp.crisp_add_helpdesk_locale_section
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_locale_section_exists Read

Execute the official Crisp REST API method `checkHelpdeskLocaleSectionExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/section/{sectionId}.

Lua path
app.integrations.crisp.check_helpdesk_locale_section_exists
Full name
crisp.crisp_check_helpdesk_locale_section_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_locale_section Read

Execute the official Crisp REST API method `resolveHelpdeskLocaleSection` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/section/{sectionId}.

Lua path
app.integrations.crisp.resolve_helpdesk_locale_section
Full name
crisp.crisp_resolve_helpdesk_locale_section
ParameterTypeRequiredDescription
No parameters.
save_helpdesk_locale_section Write

Execute the official Crisp REST API method `saveHelpdeskLocaleSection` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/section/{sectionId}.

Lua path
app.integrations.crisp.save_helpdesk_locale_section
Full name
crisp.crisp_save_helpdesk_locale_section
ParameterTypeRequiredDescription
No parameters.
update_helpdesk_locale_section Write

Execute the official Crisp REST API method `updateHelpdeskLocaleSection` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/section/{sectionId}.

Lua path
app.integrations.crisp.update_helpdesk_locale_section
Full name
crisp.crisp_update_helpdesk_locale_section
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk_locale_section Write

Execute the official Crisp REST API method `deleteHelpdeskLocaleSection` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk/locale/{locale}/category/{categoryId}/section/{sectionId}.

Lua path
app.integrations.crisp.delete_helpdesk_locale_section
Full name
crisp.crisp_delete_helpdesk_locale_section
ParameterTypeRequiredDescription
No parameters.
map_helpdesk_locale_feedback_ratings Read

Execute the official Crisp REST API method `mapHelpdeskLocaleFeedbackRatings` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/feedback/ratings.

Lua path
app.integrations.crisp.map_helpdesk_locale_feedback_ratings
Full name
crisp.crisp_map_helpdesk_locale_feedback_ratings
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_locale_feedbacks Read

Execute the official Crisp REST API method `listHelpdeskLocaleFeedbacks` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/locale/{locale}/feedback/list/{pageNumber}.

Lua path
app.integrations.crisp.list_helpdesk_locale_feedbacks
Full name
crisp.crisp_list_helpdesk_locale_feedbacks
ParameterTypeRequiredDescription
No parameters.
import_external_helpdesk_locale Write

Execute the official Crisp REST API method `importExternalHelpdeskToLocale` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/import.

Lua path
app.integrations.crisp.import_external_helpdesk_locale
Full name
crisp.crisp_import_external_helpdesk_to_locale
ParameterTypeRequiredDescription
No parameters.
export_helpdesk_locale_articles Write

Execute the official Crisp REST API method `exportHelpdeskLocaleArticles` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/locale/{locale}/export.

Lua path
app.integrations.crisp.export_helpdesk_locale_articles
Full name
crisp.crisp_export_helpdesk_locale_articles
ParameterTypeRequiredDescription
No parameters.
list_helpdesk_redirections Read

Execute the official Crisp REST API method `listHelpdeskRedirections` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/redirections/{pageNumber}.

Lua path
app.integrations.crisp.list_helpdesk_redirections
Full name
crisp.crisp_list_helpdesk_redirections
ParameterTypeRequiredDescription
No parameters.
add_helpdesk_redirection Write

Execute the official Crisp REST API method `addHelpdeskRedirection` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/helpdesk/redirection.

Lua path
app.integrations.crisp.add_helpdesk_redirection
Full name
crisp.crisp_add_helpdesk_redirection
ParameterTypeRequiredDescription
No parameters.
check_helpdesk_redirection_exists Read

Execute the official Crisp REST API method `checkHelpdeskRedirectionExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/helpdesk/redirection/{redirectionId}.

Lua path
app.integrations.crisp.check_helpdesk_redirection_exists
Full name
crisp.crisp_check_helpdesk_redirection_exists
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_redirection Read

Execute the official Crisp REST API method `resolveHelpdeskRedirection` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/redirection/{redirectionId}.

Lua path
app.integrations.crisp.resolve_helpdesk_redirection
Full name
crisp.crisp_resolve_helpdesk_redirection
ParameterTypeRequiredDescription
No parameters.
delete_helpdesk_redirection Write

Execute the official Crisp REST API method `deleteHelpdeskRedirection` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/helpdesk/redirection/{redirectionId}.

Lua path
app.integrations.crisp.delete_helpdesk_redirection
Full name
crisp.crisp_delete_helpdesk_redirection
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_settings Read

Execute the official Crisp REST API method `resolveHelpdeskSettings` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/settings.

Lua path
app.integrations.crisp.resolve_helpdesk_settings
Full name
crisp.crisp_resolve_helpdesk_settings
ParameterTypeRequiredDescription
No parameters.
save_helpdesk_settings Write

Execute the official Crisp REST API method `saveHelpdeskSettings` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/helpdesk/settings.

Lua path
app.integrations.crisp.save_helpdesk_settings
Full name
crisp.crisp_save_helpdesk_settings
ParameterTypeRequiredDescription
No parameters.
resolve_helpdesk_domain Read

Execute the official Crisp REST API method `resolveHelpdeskDomain` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/domain.

Lua path
app.integrations.crisp.resolve_helpdesk_domain
Full name
crisp.crisp_resolve_helpdesk_domain
ParameterTypeRequiredDescription
No parameters.
request_helpdesk_domain_change Write

Execute the official Crisp REST API method `requestHelpdeskDomainChange` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/helpdesk/domain.

Lua path
app.integrations.crisp.request_helpdesk_domain_change
Full name
crisp.crisp_request_helpdesk_domain_change
ParameterTypeRequiredDescription
No parameters.
generate_helpdesk_domain_setup_flow Read

Execute the official Crisp REST API method `generateHelpdeskDomainSetupFlow` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/helpdesk/domain/setup.

Lua path
app.integrations.crisp.generate_helpdesk_domain_setup_flow
Full name
crisp.crisp_generate_helpdesk_domain_setup_flow
ParameterTypeRequiredDescription
No parameters.
list_inboxes Read

Execute the official Crisp REST API method `listInboxes` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/inboxes/list/{pageNumber}.

Lua path
app.integrations.crisp.list_inboxes
Full name
crisp.crisp_list_inboxes
ParameterTypeRequiredDescription
No parameters.
batch_order_inboxes Write

Execute the official Crisp REST API method `batchOrderInboxes` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/inboxes/batch/order.

Lua path
app.integrations.crisp.batch_order_inboxes
Full name
crisp.crisp_batch_order_inboxes
ParameterTypeRequiredDescription
No parameters.
create_new_inbox Write

Execute the official Crisp REST API method `createNewInbox` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/inbox.

Lua path
app.integrations.crisp.create_new_inbox
Full name
crisp.crisp_create_new_inbox
ParameterTypeRequiredDescription
No parameters.
check_inbox_exists Read

Execute the official Crisp REST API method `checkInboxExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/inbox/{inboxID}.

Lua path
app.integrations.crisp.check_inbox_exists
Full name
crisp.crisp_check_inbox_exists
ParameterTypeRequiredDescription
No parameters.
get_inbox Read

Execute the official Crisp REST API method `getInbox` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/inbox/{inboxID}.

Lua path
app.integrations.crisp.get_inbox
Full name
crisp.crisp_get_inbox
ParameterTypeRequiredDescription
No parameters.
save_inbox Write

Execute the official Crisp REST API method `saveInbox` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/inbox/{inboxID}.

Lua path
app.integrations.crisp.save_inbox
Full name
crisp.crisp_save_inbox
ParameterTypeRequiredDescription
No parameters.
delete_inbox Write

Execute the official Crisp REST API method `deleteInbox` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/inbox/{inboxID}.

Lua path
app.integrations.crisp.delete_inbox
Full name
crisp.crisp_delete_inbox
ParameterTypeRequiredDescription
No parameters.
list_website_operators Read

Execute the official Crisp REST API method `listWebsiteOperators` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/operators/list.

Lua path
app.integrations.crisp.list_website_operators
Full name
crisp.crisp_list_website_operators
ParameterTypeRequiredDescription
No parameters.
list_last_active_website_operators Read

Execute the official Crisp REST API method `listLastActiveWebsiteOperators` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/operators/active.

Lua path
app.integrations.crisp.list_last_active_website_operators
Full name
crisp.crisp_list_last_active_website_operators
ParameterTypeRequiredDescription
No parameters.
flush_last_active_website_operators Write

Execute the official Crisp REST API method `flushLastActiveWebsiteOperators` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/operators/active.

Lua path
app.integrations.crisp.flush_last_active_website_operators
Full name
crisp.crisp_flush_last_active_website_operators
ParameterTypeRequiredDescription
No parameters.
send_email_website_operators Write

Execute the official Crisp REST API method `sendEmailToWebsiteOperators` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/operators/email.

Lua path
app.integrations.crisp.send_email_website_operators
Full name
crisp.crisp_send_email_to_website_operators
ParameterTypeRequiredDescription
No parameters.
get_website_operator Read

Execute the official Crisp REST API method `getWebsiteOperator` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/operator/{userID}.

Lua path
app.integrations.crisp.get_website_operator
Full name
crisp.crisp_get_website_operator
ParameterTypeRequiredDescription
No parameters.
invite_website_operator Write

Execute the official Crisp REST API method `inviteWebsiteOperator` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/operator.

Lua path
app.integrations.crisp.invite_website_operator
Full name
crisp.crisp_invite_website_operator
ParameterTypeRequiredDescription
No parameters.
change_operator_membership Write

Execute the official Crisp REST API method `changeOperatorMembership` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/operator/{userID}.

Lua path
app.integrations.crisp.change_operator_membership
Full name
crisp.crisp_change_operator_membership
ParameterTypeRequiredDescription
No parameters.
get_people_statistics Read

Execute the official Crisp REST API method `getPeopleStatistics` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/stats.

Lua path
app.integrations.crisp.get_people_statistics
Full name
crisp.crisp_get_people_statistics
ParameterTypeRequiredDescription
No parameters.
list_suggested_people_segments Read

Execute the official Crisp REST API method `listSuggestedPeopleSegments` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/suggest/segments/{pageNumber}.

Lua path
app.integrations.crisp.list_suggested_people_segments
Full name
crisp.crisp_list_suggested_people_segments
ParameterTypeRequiredDescription
No parameters.
delete_suggested_people_segment Write

Execute the official Crisp REST API method `deleteSuggestedPeopleSegment` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/people/suggest/segment.

Lua path
app.integrations.crisp.delete_suggested_people_segment
Full name
crisp.crisp_delete_suggested_people_segment
ParameterTypeRequiredDescription
No parameters.
list_suggested_people_data_keys Read

Execute the official Crisp REST API method `listSuggestedPeopleDataKeys` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/suggest/data/{pageNumber}.

Lua path
app.integrations.crisp.list_suggested_people_data_keys
Full name
crisp.crisp_list_suggested_people_data_keys
ParameterTypeRequiredDescription
No parameters.
delete_suggested_people_data_key Write

Execute the official Crisp REST API method `deleteSuggestedPeopleDataKey` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/people/suggest/data.

Lua path
app.integrations.crisp.delete_suggested_people_data_key
Full name
crisp.crisp_delete_suggested_people_data_key
ParameterTypeRequiredDescription
No parameters.
list_suggested_people_events Read

Execute the official Crisp REST API method `listSuggestedPeopleEvents` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/suggest/events/{pageNumber}.

Lua path
app.integrations.crisp.list_suggested_people_events
Full name
crisp.crisp_list_suggested_people_events
ParameterTypeRequiredDescription
No parameters.
delete_suggested_people_event Write

Execute the official Crisp REST API method `deleteSuggestedPeopleEvent` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/people/suggest/event.

Lua path
app.integrations.crisp.delete_suggested_people_event
Full name
crisp.crisp_delete_suggested_people_event
ParameterTypeRequiredDescription
No parameters.
list_people_profiles Read

Execute the official Crisp REST API method `listPeopleProfiles` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/profiles/{pageNumber}.

Lua path
app.integrations.crisp.list_people_profiles
Full name
crisp.crisp_list_people_profiles
ParameterTypeRequiredDescription
No parameters.
add_new_people_profile Write

Execute the official Crisp REST API method `addNewPeopleProfile` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/people/profile.

Lua path
app.integrations.crisp.add_new_people_profile
Full name
crisp.crisp_add_new_people_profile
ParameterTypeRequiredDescription
No parameters.
check_people_profile_exists Read

Execute the official Crisp REST API method `checkPeopleProfileExists` from node-crisp-api. Official Crisp endpoint: HEAD /v1/website/{websiteID}/people/profile/{peopleID}.

Lua path
app.integrations.crisp.check_people_profile_exists
Full name
crisp.crisp_check_people_profile_exists
ParameterTypeRequiredDescription
No parameters.
get_people_profile Read

Execute the official Crisp REST API method `getPeopleProfile` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/profile/{peopleID}.

Lua path
app.integrations.crisp.get_people_profile
Full name
crisp.crisp_get_people_profile
ParameterTypeRequiredDescription
No parameters.
save_people_profile Write

Execute the official Crisp REST API method `savePeopleProfile` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/people/profile/{peopleID}.

Lua path
app.integrations.crisp.save_people_profile
Full name
crisp.crisp_save_people_profile
ParameterTypeRequiredDescription
No parameters.
update_people_profile Write

Execute the official Crisp REST API method `updatePeopleProfile` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/people/profile/{peopleID}.

Lua path
app.integrations.crisp.update_people_profile
Full name
crisp.crisp_update_people_profile
ParameterTypeRequiredDescription
No parameters.
remove_people_profile Write

Execute the official Crisp REST API method `removePeopleProfile` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/people/profile/{peopleID}.

Lua path
app.integrations.crisp.remove_people_profile
Full name
crisp.crisp_remove_people_profile
ParameterTypeRequiredDescription
No parameters.
list_people_conversations Read

Execute the official Crisp REST API method `listPeopleConversations` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/conversations/{peopleID}/list/{pageNumber}.

Lua path
app.integrations.crisp.list_people_conversations
Full name
crisp.crisp_list_people_conversations
ParameterTypeRequiredDescription
No parameters.
list_people_campaigns Read

Execute the official Crisp REST API method `listPeopleCampaigns` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/campaigns/{peopleID}/list/{pageNumber}.

Lua path
app.integrations.crisp.list_people_campaigns
Full name
crisp.crisp_list_people_campaigns
ParameterTypeRequiredDescription
No parameters.
add_people_event Write

Execute the official Crisp REST API method `addPeopleEvent` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/people/events/{peopleID}.

Lua path
app.integrations.crisp.add_people_event
Full name
crisp.crisp_add_people_event
ParameterTypeRequiredDescription
No parameters.
list_people_events Read

Execute the official Crisp REST API method `listPeopleEvents` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/events/{peopleID}/list/{pageNumber}.

Lua path
app.integrations.crisp.list_people_events
Full name
crisp.crisp_list_people_events
ParameterTypeRequiredDescription
No parameters.
get_people_data Read

Execute the official Crisp REST API method `getPeopleData` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/data/{peopleID}.

Lua path
app.integrations.crisp.get_people_data
Full name
crisp.crisp_get_people_data
ParameterTypeRequiredDescription
No parameters.
save_people_data Write

Execute the official Crisp REST API method `savePeopleData` from node-crisp-api. Official Crisp endpoint: PUT /v1/website/{websiteID}/people/data/{peopleID}.

Lua path
app.integrations.crisp.save_people_data
Full name
crisp.crisp_save_people_data
ParameterTypeRequiredDescription
No parameters.
update_people_data Write

Execute the official Crisp REST API method `updatePeopleData` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/people/data/{peopleID}.

Lua path
app.integrations.crisp.update_people_data
Full name
crisp.crisp_update_people_data
ParameterTypeRequiredDescription
No parameters.
get_people_subscription_status Read

Execute the official Crisp REST API method `getPeopleSubscriptionStatus` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/people/subscription/{peopleID}.

Lua path
app.integrations.crisp.get_people_subscription_status
Full name
crisp.crisp_get_people_subscription_status
ParameterTypeRequiredDescription
No parameters.
update_people_subscription_status Write

Execute the official Crisp REST API method `updatePeopleSubscriptionStatus` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/people/subscription/{peopleID}.

Lua path
app.integrations.crisp.update_people_subscription_status
Full name
crisp.crisp_update_people_subscription_status
ParameterTypeRequiredDescription
No parameters.
export_people_profiles Write

Execute the official Crisp REST API method `exportPeopleProfiles` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/people/export/profiles.

Lua path
app.integrations.crisp.export_people_profiles
Full name
crisp.crisp_export_people_profiles
ParameterTypeRequiredDescription
No parameters.
import_people_profiles Write

Execute the official Crisp REST API method `importPeopleProfiles` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/people/import/profiles.

Lua path
app.integrations.crisp.import_people_profiles
Full name
crisp.crisp_import_people_profiles
ParameterTypeRequiredDescription
No parameters.
get_website_settings Read

Execute the official Crisp REST API method `getWebsiteSettings` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/settings.

Lua path
app.integrations.crisp.get_website_settings
Full name
crisp.crisp_get_website_settings
ParameterTypeRequiredDescription
No parameters.
update_website_settings Write

Execute the official Crisp REST API method `updateWebsiteSettings` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/settings.

Lua path
app.integrations.crisp.update_website_settings
Full name
crisp.crisp_update_website_settings
ParameterTypeRequiredDescription
No parameters.
get_verify_settings Read

Execute the official Crisp REST API method `getVerifySettings` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/verify/settings.

Lua path
app.integrations.crisp.get_verify_settings
Full name
crisp.crisp_get_verify_settings
ParameterTypeRequiredDescription
No parameters.
update_verify_settings Write

Execute the official Crisp REST API method `updateVerifySettings` from node-crisp-api. Official Crisp endpoint: PATCH /v1/website/{websiteID}/verify/settings.

Lua path
app.integrations.crisp.update_verify_settings
Full name
crisp.crisp_update_verify_settings
ParameterTypeRequiredDescription
No parameters.
get_verify_key Read

Execute the official Crisp REST API method `getVerifyKey` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/verify/key.

Lua path
app.integrations.crisp.get_verify_key
Full name
crisp.crisp_get_verify_key
ParameterTypeRequiredDescription
No parameters.
roll_verify_key Write

Execute the official Crisp REST API method `rollVerifyKey` from node-crisp-api. Official Crisp endpoint: POST /v1/website/{websiteID}/verify/key.

Lua path
app.integrations.crisp.roll_verify_key
Full name
crisp.crisp_roll_verify_key
ParameterTypeRequiredDescription
No parameters.
count_visitors Read

Execute the official Crisp REST API method `countVisitors` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/visitors/count.

Lua path
app.integrations.crisp.count_visitors
Full name
crisp.crisp_count_visitors
ParameterTypeRequiredDescription
No parameters.
list_visitors Read

Execute the official Crisp REST API method `listVisitors` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/visitors/list/{pageNumber}.

Lua path
app.integrations.crisp.list_visitors
Full name
crisp.crisp_list_visitors
ParameterTypeRequiredDescription
No parameters.
pinpoint_visitors_map Read

Execute the official Crisp REST API method `pinpointVisitorsOnMap` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/visitors/map.

Lua path
app.integrations.crisp.pinpoint_visitors_map
Full name
crisp.crisp_pinpoint_visitors_on_map
ParameterTypeRequiredDescription
No parameters.
get_session_identifier_from_token Read

Execute the official Crisp REST API method `getSessionIdentifierFromToken` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/visitors/token/{tokenID}.

Lua path
app.integrations.crisp.get_session_identifier_from_token
Full name
crisp.crisp_get_session_identifier_from_token
ParameterTypeRequiredDescription
No parameters.
count_blocked_visitors Read

Execute the official Crisp REST API method `countBlockedVisitors` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/visitors/blocked.

Lua path
app.integrations.crisp.count_blocked_visitors
Full name
crisp.crisp_count_blocked_visitors
ParameterTypeRequiredDescription
No parameters.
count_blocked_visitors_rule Read

Execute the official Crisp REST API method `countBlockedVisitorsInRule` from node-crisp-api. Official Crisp endpoint: GET /v1/website/{websiteID}/visitors/blocked/{rule}.

Lua path
app.integrations.crisp.count_blocked_visitors_rule
Full name
crisp.crisp_count_blocked_visitors_in_rule
ParameterTypeRequiredDescription
No parameters.
clear_blocked_visitors_rule Write

Execute the official Crisp REST API method `clearBlockedVisitorsInRule` from node-crisp-api. Official Crisp endpoint: DELETE /v1/website/{websiteID}/visitors/blocked/{rule}.

Lua path
app.integrations.crisp.clear_blocked_visitors_rule
Full name
crisp.crisp_clear_blocked_visitors_in_rule
ParameterTypeRequiredDescription
No parameters.