Webhooks

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/webhooks

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/webhooks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

post

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

urlstringRequired

subscribed_tostring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

discord_description_templatenull | stringOptional

discord_titlenull | stringOptional

discord_colornull | stringOptional

Responses

200

OK

application/json

default

Error response

application/json

post

/v1/stores/{storeId}/webhooks

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/webhooks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "url": "text",
  "subscribed_to": "on_ignore",
  "type": "json_v1",
  "discord_description_template": null,
  "discord_title": null,
  "discord_color": null
}

application/jsontext/jsonapplication/*+json

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

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

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

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/webhooks/variables HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

delete

Authorizations

APIKey

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

default

Error response

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/webhooks/{webhookId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

patch

Authorizations

APIKey

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

application/jsontext/jsonapplication/*+json

urlstringRequired

reset_secretbooleanRequired

subscribed_tostring · enumRequiredPossible values:

discord_description_templatenull | stringOptional

discord_titlenull | stringOptional

discord_colornull | stringOptional

Responses

200

OK

application/json

default

Error response

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/webhooks/{webhookId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "url": "text",
  "reset_secret": true,
  "subscribed_to": "on_ignore",
  "discord_description_template": null,
  "discord_title": null,
  "discord_color": null
}

application/jsontext/jsonapplication/*+json

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

post

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

webhook_idstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

default

Error response

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "webhook_id": "411486491630370816"
}

application/jsontext/jsonapplication/*+json

No content

get

Authorizations

APIKey

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

OK

application/json

default

Error response

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "page": 1,
  "history": [
    {
      "id": "411486491630370816",
      "webhook_id": "411486491630370816",
      "created_at": "2025-12-12T13:36:06.470Z",
      "state": "success",
      "next_retry": null,
      "event": "on_ignore",
      "payload": null,
      "executions": [
        {
          "id": "411486491630370816",
          "started_at": "2025-12-12T13:36:06.470Z",
          "finished_at": null,
          "status_code": 1,
          "response": null
        }
      ]
    }
  ]
}