List a program's webhooks

GET

/programs/{id}/webhooks

Signing secrets and custom header values are masked on read.

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)

Parameters

Path Parameters

id*

An opaque id. The API never promises an id format.

Type

string

Required

Responses

List a program's webhooks

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"id": "whk_docsfixture0001",

  

  

  

"shop_id": "shp_docsfixture0001",

  

  

  

"program_id": "prg_docsfixture0001",

  

  

  

"url": "https://hooks.example.com/tesserapp",

  

  

  

"events": [

  

  

  

  

"stamp.assigned"

  

  

  

],

  

  

  

"active": true,

  

  

  

"description": "CRM sync — production receiver",

  

  

  

"has_bearer_token": true,

  

  

  

"program_ids": [

  

  

  

  

"prg_docsfixture0001"

  

  

  

],

  

  

  

"location_ids": [

  

  

  

  

"loc_docsfixture0001"

  

  

  

],

  

  

  

"include_shop_wide_events": true,

  

  

  

"http_method": "POST",

  

  

  

"custom_headers": {

  

  

  

  

"X-Partner-Token": "••••"

  

  

  

},

  

  

  

"payload_version": "v1",

  

  

  

"consecutive_failures": 0,

  

  

  

"created_at": "2026-08-05T10:15:00.000Z",

  

  

  

"updated_at": "2026-09-04T10:15:00.000Z"

  

  

}

  

]

}

GET

/programs/{id}/webhooks

Samples

Powered by VitePress OpenAPI