Webhooks

Send test webhook

Delivers a synthetic `webhook.test` event to the subscription and returns the delivery result.

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

POSThttps://api.maple.inc/v1/webhook_subscriptions/{subscriptionId}/testAPI 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_test_result.
event_id string required
delivered boolean required
response_status number or null required

Errors

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

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.

Send test webhook

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

import os
import requests

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

{
  "object": "webhook_test_result",
  "event_id": "string",
  "delivered": true,
  "response_status": 1.5
}

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