Skip to main content
GET

Overview

The Get Webhooks endpoint returns a list of all webhook endpoints you’ve registered. Use this to view your webhook configurations, check their status, and retrieve webhook IDs for updates or deletions.

Endpoint

Authentication

This endpoint requires HTTP Basic Authentication using your Secret Key.

Request

Headers

Parameters

This endpoint does not accept any query parameters or request body.

Response

Success Response

Status Code: 200 OK Returns an array of webhook objects.
array
required
Array of all registered webhooks for your merchant account. Returns an empty array [] if no webhooks are registered.Each webhook object contains:

Response Examples

Error Responses

Status Code: 401Cause: Invalid or missing authentication credentialsResponse Example:
Solution:
  • Verify your secret key is correct
  • Ensure Authorization header format: Basic {base64(secret_key:)}
  • Check you’re using the right environment (sandbox vs production)
Status Code: 403Cause: Account disabled or API access revokedSolution:
  • Contact Modulus Labs support
  • Verify your account status
Status Code: 500Cause: Unexpected server errorSolution:
  • Retry the request
  • If the issue persists, contact Modulus Labs support

Use Cases

Verify which webhooks are active and what events they receive:
Retrieve the webhook ID before updating or deleting:
Check if your webhooks are enabled in health checks:
Check if a webhook URL is already registered before creating:
Compare current webhooks with expected configuration:

Best Practices

Cache Webhook Configuration

Cache webhook IDs in your application to avoid repeated API calls:

Regular Health Checks

Periodically verify webhooks are enabled and configured correctly:

Log Webhook Changes

Track webhook configuration changes for audit purposes:

Validate Expected Configuration

Ensure critical webhooks are present and enabled:

Filtering and Processing Webhooks

Troubleshooting

Symptom: Response returns {"webhooks": []}Possible Causes:
  • No webhooks have been created yet
  • Using wrong secret key (different merchant account)
  • Webhooks were deleted
Solutions:
  • Verify you’re using the correct secret key
  • Create a webhook using the Create Webhook API
  • Check if you’re in the right environment (sandbox vs production)
Symptom: Webhook you created is not in the listPossible Causes:
  • Wrong secret key (different merchant account)
  • Webhook was deleted
  • API cache delay (rare)
Solutions:
  • Verify secret key matches the one used to create the webhook
  • Check if webhook was accidentally deleted
  • Retry the request after a few seconds
Symptom: Webhook status or URL doesn’t match recent updatesPossible Causes:
  • Application caching old data
  • Race condition with concurrent updates
Solutions:
  • Clear application cache
  • Call Get Webhooks API again to refresh data
  • Implement cache invalidation after updates

Next Steps

Create Webhook

Register a new webhook endpoint

Update Webhook

Modify existing webhook configuration

Delete Webhook

Remove a webhook endpoint

Webhooks Overview

Learn about the Webhook API

Authorizations

Authorization
string
header
required

HTTP Basic Authentication using your Secret Key as the username and an empty password

Response

List of webhooks retrieved successfully

id
string

Unique identifier for the webhook

webhookAction
enum<string>[]

List of transaction events this webhook receives

Available options:
QRPH_SUCCESS,
QRPH_DECLINED
webhookStatus
enum<string>

Current status of the webhook

Available options:
ENABLED,
DISABLED
webhookUrl
string<uri>

The HTTPS URL where notifications are sent