Webhooks

get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Responses
200
OK
application/json
get
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": "text",
    "discord_title": "text",
    "discord_color": "text"
  }
]
post
Authorizations
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
Responses
200
OK
application/json
post
POST /v1/stores/{storeId}/webhooks HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "url": "text",
  "subscribed_to": "on_ignore",
  "type": "json_v1",
  "discord_description_template": "text",
  "discord_title": "text",
  "discord_color": "text"
}
{
  "id": "411486491630370816",
  "url": "text",
  "secret": "text",
  "subscribed_to": "on_ignore",
  "type": "json_v1",
  "discord_description_template": "text",
  "discord_title": "text",
  "discord_color": "text"
}
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Responses
200
OK
application/json
get
GET /v1/stores/{storeId}/webhooks/variables HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "event_type": "on_ignore",
    "variables": [
      "text"
    ]
  }
]
delete
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
webhookIdstring · flake-idRequiredExample: 411486491630370816
Responses
204
No Content
delete
DELETE /v1/stores/{storeId}/webhooks/{webhookId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
patch
Authorizations
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
Responses
200
OK
application/json
patch
PATCH /v1/stores/{storeId}/webhooks/{webhookId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "url": "text",
  "reset_secret": true,
  "subscribed_to": "on_ignore",
  "discord_description_template": "text",
  "discord_title": "text",
  "discord_color": "text"
}
{
  "id": "411486491630370816",
  "url": "text",
  "secret": "text",
  "subscribed_to": "on_ignore",
  "type": "json_v1",
  "discord_description_template": "text",
  "discord_title": "text",
  "discord_color": "text"
}
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
webhookIdstring · flake-idRequiredExample: 411486491630370816
Query parameters
pageinteger · int32Optional
statestringOptional
Responses
200
OK
application/json
get
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-08-01T19:06:20.989Z",
      "state": "success",
      "next_retry": "2025-08-01T19:06:20.989Z",
      "event": "on_ignore",
      "payload": null,
      "executions": [
        {
          "id": "411486491630370816",
          "started_at": "2025-08-01T19:06:20.989Z",
          "finished_at": "2025-08-01T19:06:20.989Z",
          "status_code": 1,
          "response": "text"
        }
      ]
    }
  ]
}
PreviousTagsNextModels

Was this helpful?