Skip to main content

Managing Webhook Targets

A target is a URL that receives your webhooks. Every target in a workspace receives every event — there is no per-event subscription — so if you need different events in different places, filter on type in your own handler.

You can configure up to 5 targets per workspace.

Authentication​

These endpoints use the v2 bearer token, not the v3 API-key signature:

Authorization: Bearer <your_jwt_token>

Add a target​

POST /api/v2/webhooks/targets
Authorization: Bearer <your_jwt_token>
Content-Type: application/json

{
  "url": "https://merchant.example.com/blockwyre/webhook"
}

200 OK

{
  "id": "019f1234-5678-90ab-cdef-1234567890ab",
  "url": "https://merchant.example.com/blockwyre/webhook",
  "createdAt": "2026-02-12T18:10:00Z"
}
StatusMeaning
400The URL is not a valid URL
409That URL is already a target in this workspace, or you already have 5

List targets​

GET /api/v2/webhooks/targets
Authorization: Bearer <your_jwt_token>

200 OK

{
  "data": [
    {
      "id": "019f1234-5678-90ab-cdef-1234567890ab",
      "url": "https://merchant.example.com/blockwyre/webhook",
      "createdAt": "2026-02-12T18:10:00Z"
    }
  ]
}
How to tell a target is disabled

disabledAt is absent while a target is healthy, and carries a timestamp once the target has been disabled for repeated failures. Test for the field's presence — do not compare it against a zero date, which is not what the API returns.

A disabled target looks like this:

{
  "id": "019f1234-5678-90ab-cdef-1234567890ab",
  "url": "https://merchant.example.com/blockwyre/webhook",
  "createdAt": "2026-02-12T18:10:00Z",
  "disabledAt": "2026-03-04T09:22:11Z"
}

Re-enable a disabled target​

A target is disabled automatically after five consecutive failed deliveries. Fix whatever was failing first — re-enabling an endpoint that still returns 500 simply spends the five attempts again.

PATCH /api/v2/webhooks/targets/{targetId}/enable
Authorization: Bearer <your_jwt_token>

204 No Content

Events that arrived while the target was disabled are not replayed. Reconcile through the API for anything you may have missed.

Delete a target​

DELETE /api/v2/webhooks/targets/{targetId}
Authorization: Bearer <your_jwt_token>

204 No Content

Deleting is permanent and frees one of your five slots. To stop delivery temporarily, prefer leaving the target in place — a deleted target cannot be restored, and recreating it issues a new id.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!