Plaidly Docs

Recipe: Configure a Webhook

Set and verify the merchant webhook endpoint

Configure a Webhook

Set the webhook URL

Today, webhook_url is set exactly once: at merchant registration.

curl -X POST https://api.plaidly.io/v1/merchants \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Agent Quickstart Merchant",
    "sandbox": true,
    "webhook_url": "https://example.com/webhook"
  }'

There is currently no endpoint to change webhook_url after registration. GET /v1/me returns the current value for inspection, but there is no PATCH/PUT to update it. If you need a different URL, register a new sandbox merchant (cheap and unauthenticated) rather than trying to mutate the existing one.

Confirm what's configured

curl https://api.plaidly.io/v1/me \
  -H "X-API-Key: your_api_key"

Check the webhook_url field in the response.

Verify signing works end to end

Once configured, every event Plaidly sends to webhook_url is signed with the webhook_secret returned at registration. Confirm your receiver can validate it before wiring up real fulfillment logic — see Verify a webhook event for the exact HMAC check, and Webhooks for the event catalog and retry schedule.

For local development, point webhook_url at a public tunnel (e.g. ngrok http 3000) rather than localhost — Plaidly's servers cannot reach your machine directly.

Next

On this page