Webhooks
Webhooks allow your system to receive real-time notifications from Guru Pay when specific events occur (transaction processing completed, new transaction is created, etc.). You can manage your webhook configuration using the following endpoints.
You must include your Bearer token in the request header.
Creates a new webhook configuration for the authenticated user.
Data required to create a new webhook configuration.
The target URL endpoint for the webhook messages.
https://example.com/my-webhook-listener
A secret token sent with webhook messages for verification (e.g., in an 'Authorization' or custom header). Min 16, Max 100 characters.
whsec_aBcDeFgHiJkLmNoPqRsTuV
A user-friendly name for the webhook configuration.
Production Transaction Webhook
An optional description for the webhook configuration.
Notifies the main system about new transactions.
POST /api/v1/webhooks HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 193
{
"url": "https://example.com/my-webhook-listener",
"token": "whsec_aBcDeFgHiJkLmNoPqRsTuV",
"name": "Production Transaction Webhook",
"description": "Notifies the main system about new transactions."
}
{
"uuid": "b2e1d0c9-f8a7-4b6a-9c5d-4e3f2a1b0d9e",
"is_active": true,
"url": "https://example.com/webhooks/receiver",
"token": "whsec_...masked...",
"name": "My Transaction Notifier",
"description": "Sends notifications for completed SEPA transactions."
}
Shows the webhook configuration associated with the authenticated account/user.
GET /api/v1/webhooks HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"uuid": "b2e1d0c9-f8a7-4b6a-9c5d-4e3f2a1b0d9e",
"is_active": true,
"url": "https://example.com/webhooks/receiver",
"token": "whsec_...masked...",
"name": "My Transaction Notifier",
"description": "Sends notifications for completed SEPA transactions."
}
Updates the webhook configuration associated with the authenticated user.
Data required to update an existing webhook configuration. All fields are typically required for PUT/replace semantics, but PATCH might allow partial updates (adjust schema 'required' if using PATCH).
Whether the webhook subscription should be active.
true
The target URL endpoint for the webhook messages.
https://example.com/my-updated-webhook-listener
A secret token sent with webhook messages for verification. Min 16, Max 100 characters.
whsec_xYzAbCdEfGhIjKlMnOpQrS
A user-friendly name for the webhook configuration.
Updated Production Webhook
An optional description for the webhook configuration.
Updated description for the webhook.
PUT /api/v1/webhooks HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"is_active": true,
"url": "https://example.com/my-updated-webhook-listener",
"token": "whsec_xYzAbCdEfGhIjKlMnOpQrS",
"name": "Updated Production Webhook",
"description": "Updated description for the webhook."
}
{
"uuid": "b2e1d0c9-f8a7-4b6a-9c5d-4e3f2a1b0d9e",
"is_active": true,
"url": "https://example.com/webhooks/receiver",
"token": "whsec_...masked...",
"name": "My Transaction Notifier",
"description": "Sends notifications for completed SEPA transactions."
}
Last updated
Was this helpful?