create_webhook
Create a pending order event subscription to a public HTTPS receiver. Returns its signing secret ONCE. The receiver must echo the signed verification challenge before activation. No customer contact fields are sent. Check expires_at and requires_active_grant. OAuth scopes: webhooks:write, orders:read. Changes buyer or order state.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"callback_url": "<callback_url>",
"events": "<events>"
},
"name": "create_webhook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| events | Yes | Distinct order event categories to subscribe to for this application and consenting buyer session. No customer contact fields are included. | |
| callback_url | Yes | Public HTTPS receiver under your control for signed verification and order events. Private-network, credential-bearing and unsafe receiver URLs are rejected; echo the signed challenge to activate. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| events | Yes | ||
| status | Yes | ||
| created_at | Yes | ||
| expires_at | Yes | ||
| updated_at | Yes | ||
| callback_url | Yes | ||
| signing_secret | Yes | ||
| requires_active_grant | Yes |