Webhooks

List webhook subscriptions

Lists the app's webhook subscriptions in the credential's environment.

Esta página aún no está disponible en tu idioma.

GEThttps://api.maple.inc/v1/webhook_subscriptionsAPI 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.

Responses

200 OK

object string required

Always list.
data object[] required
data[].object string required

Always webhook_subscription.
data[].id string required
data[].environment string required

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

One of enabled, disabled.
data[].created_at string required
data[].updated_at string required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
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.

List webhook subscriptions

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

import os
import requests

r = requests.get(
    f"{os.environ['MAPLE_BASE']}/webhook_subscriptions",
    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`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "list",
  "data": [
    {
      "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"
}