The webhook event catalogue

GET

/events

Every subscribable event with one payload example each, generated from the builders.

Authorizations

ApiKeyBearer

A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.

Type

HTTP (bearer)

Responses

The webhook event catalogue

Content-Type

application/json

{

  

"events": [

  

  

{

  

  

  

"event": "stamp.assigned",

  

  

  

"shop_wide": false,

  

  

  

"card_bearing": true,

  

  

  

"transaction_specific": true,

  

  

  

"firehose": false

  

  

}

  

]

}

GET

/events

Samples

Powered by VitePress OpenAPI