Skip to main content
POST
Create a new support issue

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
title
string
required

Issue title

category
enum<string>
required
Available options:
bug,
feature,
workflow_issue,
template_issue,
integration,
billing,
data_diff
description
string
required
priority
enum<number>
Available options:
0,
1,
2,
3,
4
files
object[]

File attachments to include with the issue. Each file must already be hosted at a publicly accessible URL.

workflowId
string

Optional workflow ID to link the issue

templateId
string<uuid>

Optional template ID to link the issue. Only relevant when category is template_issue.

dataChangeId
string

ID of a data change from the Data Changes API (GET /v4/changes). Links the support issue to a specific data diff so the team can review the exact change being reported. Only relevant when category is data_diff.

subcategory
enum<string>

Optional subcategory for workflow or integration issues

Available options:
wrong_data,
missing_fields,
wrong_website,
scraper_broken,
other,
integration_slack,
integration_snowflake,
integration_cloud_storage,
integration_sdk,
integration_other

Response

Issue creation accepted

success
boolean
issueId
string

Local support request ID

supportRequestId
string

Local support request ID

jobId
string

Engine event job ID

status
enum<string>
Available options:
accepted