v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Integration Notification

Set up a new Webhook Notification Subscription for a Customer.

post/customers/{customerId}/integration-notifications

Path parameters

customerIdstring required

Request body

urlstring required

The URL used for sending the notification.

retryboolean required

Flag indicating whether failed webhooks should be retried.

secretstring required

Secret that is used in HMAC calculation for webhooks.

hmacAlgorithm'hmac-sha1' | 'hmac-sha256' | 'hmac-sha384' | 'hmac-sha512' required

HMAC signing algorithm used to calculate the webhook signature.

type'PAYOUT' | 'PAYIN' | 'CARD_AUTH' | 'CARD_AUTH_OFFLINE' | 'CARD_STATUS_UPDATE' | 'PAYMENT_COMPLIANCE_STATUS' required

Type of the notification.

Response

Created

idstring required

Unique Identifier for the notification

urlstring required

The URL used for sending the notification.

retryboolean required

Flag indicating whether failed webhooks should be retried.

secretstring required

Secret that is used in HMAC calculation for webhooks.

hmacAlgorithm'hmac-sha1' | 'hmac-sha256' | 'hmac-sha384' | 'hmac-sha512' required

HMAC signing algorithm used to calculate the webhook signature.

type'PAYOUT' | 'PAYIN' | 'CARD_AUTH' | 'CARD_AUTH_OFFLINE' | 'CARD_STATUS_UPDATE' | 'PAYMENT_COMPLIANCE_STATUS' required

Type of the notification.