Webhooks

Get webhook subscription

Retrieves a single webhook subscription owned by the app.

此内容尚不支持你的语言。

GEThttps://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}API key

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Parameters

subscriptionId string path required

Responses

200 OK

object string required

Always webhook_subscription.
id string required
environment string required

One of test, live.
notification_url string required
event_types string[] required
status string required

One of enabled, disabled.
created_at string required
updated_at string required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
404 Not found DeveloperApiNotFound
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

Get webhook subscription

curl "$MAPLE_BASE/webhook_subscriptions/dws_123" \
  -H "Authorization: Bearer $MAPLE_KEY"

import os
import requests

r = requests.get(
    f"{os.environ['MAPLE_BASE']}/webhook_subscriptions/dws_123",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/webhook_subscriptions/dws_123`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "webhook_subscription",
  "id": "string",
  "environment": "test",
  "notification_url": "https://example.com/webhooks/maple",
  "event_types": [
    "order.notification"
  ],
  "status": "enabled",
  "created_at": "string",
  "updated_at": "string"
}

{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}