Webhooks

get

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

idstring · flake-idRequiredExample: 411486491630370816

urlstringRequired

secretstringRequired

subscribed_tostring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

discord_description_templatestring · nullableOptional

discord_titlestring · nullableOptional

discord_colorstring · nullableOptional

discord_formatstring · enumOptionalPossible values:

default

Error response

application/json

get/v1/stores/{storeId}/webhooks

GET /v1/stores/{storeId}/webhooks HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "url": "text",
    "secret": "text",
    "subscribed_to": "OnIgnore",
    "type": "json_v1",
    "discord_description_template": null,
    "discord_title": null,
    "discord_color": null,
    "discord_format": "Invalid"
  }
]

post

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

urlstringRequired

subscribed_tostring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

discord_description_templatestring · nullableOptional

discord_titlestring · nullableOptional

discord_colorstring · nullableOptional

discord_formatstring · enumOptionalPossible values:

Responses

200

application/json

idstring · flake-idRequiredExample: 411486491630370816

urlstringRequired

secretstringRequired

subscribed_tostring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

discord_description_templatestring · nullableOptional

discord_titlestring · nullableOptional

discord_colorstring · nullableOptional

discord_formatstring · enumOptionalPossible values:

default

Error response

application/json

post/v1/stores/{storeId}/webhooks

POST /v1/stores/{storeId}/webhooks HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "url": "text",
  "subscribed_to": "OnIgnore",
  "type": "json_v1",
  "discord_description_template": null,
  "discord_title": null,
  "discord_color": null,
  "discord_format": "Invalid"
}

{
  "id": "411486491630370816",
  "url": "text",
  "secret": "text",
  "subscribed_to": "OnIgnore",
  "type": "json_v1",
  "discord_description_template": null,
  "discord_title": null,
  "discord_color": null,
  "discord_format": "Invalid"
}

get

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

application/json

event_typestring · enumRequiredPossible values:

variablesstring[]Required

default

Error response

application/json

get/v1/stores/{storeId}/webhooks/variables

GET /v1/stores/{storeId}/webhooks/variables HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "event_type": "OnIgnore",
    "variables": [
      "text"
    ]
  }
]

delete

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

webhookIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete/v1/stores/{storeId}/webhooks/{webhookId}

DELETE /v1/stores/{storeId}/webhooks/{webhookId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content

patch

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

webhookIdstring · flake-idRequiredExample: 411486491630370816

Body

urlstringRequired

reset_secretbooleanRequired

subscribed_tostring · enumRequiredPossible values:

discord_description_templatestring · nullableOptional

discord_titlestring · nullableOptional

discord_colorstring · nullableOptional

discord_formatstring · enumOptionalPossible values:

Responses

200

application/json

idstring · flake-idRequiredExample: 411486491630370816

urlstringRequired

secretstringRequired

subscribed_tostring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

discord_description_templatestring · nullableOptional

discord_titlestring · nullableOptional

discord_colorstring · nullableOptional

discord_formatstring · enumOptionalPossible values:

default

Error response

application/json

patch/v1/stores/{storeId}/webhooks/{webhookId}

PATCH /v1/stores/{storeId}/webhooks/{webhookId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "url": "text",
  "reset_secret": true,
  "subscribed_to": "OnIgnore",
  "discord_description_template": null,
  "discord_title": null,
  "discord_color": null,
  "discord_format": "Invalid"
}

{
  "id": "411486491630370816",
  "url": "text",
  "secret": "text",
  "subscribed_to": "OnIgnore",
  "type": "json_v1",
  "discord_description_template": null,
  "discord_title": null,
  "discord_color": null,
  "discord_format": "Invalid"
}

post

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

webhook_idstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

post/v1/stores/{storeId}/webhooks/resend

POST /v1/stores/{storeId}/webhooks/resend HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "webhook_id": "411486491630370816"
}

No content

get

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

webhookIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

pageinteger · int32Optional

statestringOptional

Responses

200

application/json

pageinteger · int32Required

default

Error response

application/json

get/v1/stores/{storeId}/webhooks/{webhookId}/history

GET /v1/stores/{storeId}/webhooks/{webhookId}/history HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "page": 1,
  "history": [
    {
      "id": "411486491630370816",
      "webhook_id": "411486491630370816",
      "created_at": "2026-07-11T03:49:31.121Z",
      "state": "success",
      "next_retry": null,
      "event": "OnIgnore",
      "payload": null,
      "executions": [
        {
          "id": "411486491630370816",
          "started_at": "2026-07-11T03:49:31.121Z",
          "finished_at": null,
          "status_code": 1,
          "response": null
        }
      ]
    }
  ]
}

PreviousUpsell Settings NextModels

Last updated 4 days ago

Was this helpful?