How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Modulr Integration Notification API

The Integration Notification API from Modulr — 3 operation(s) for integration notification.

Modulr Integration Notification API is one of 26 APIs that Modulr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Integration Notification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api-sandbox.modulrfinance.com/api-sandbox-token.

6 operations 3 paths 7 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.modulrfinance.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Modulr Integration Notification API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (modulo_security). An API key is passed in the header as Authorization (TOKEN). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Integration Notification 6
GET
/customers/{customerId}/integration-notifications/{notificationId}
Retrieve a specific Webhook Notification Subscription for a Customer using the Notification ID.
getCustomerWebhookNotificationSubscription 2 params → 200400404
PUT
/customers/{customerId}/integration-notifications/{notificationId}
Update a specific Webhook Notification Subscription for a Customer.
editCustomerWebhookNotificationSubscription 2 params body → 200400404
DELETE
/customers/{customerId}/integration-notifications/{notificationId}
Delete a Webhook Notification Subscription for a Customer using the Notification ID.
deleteCustomerWebhookNotificationSubscription 2 params → 204400404
GET
/customers/{customerId}/integration-notifications
Retrieve all Webhook Notification Subscriptions for a Customer.
getAllCustomerWebhookNotificationSubscriptions 3 params → 200400404
POST
/customers/{customerId}/integration-notifications
Set up a new Webhook Notification Subscription for a Customer.
addCustomerWebhookNotificationSubscription 1 param body → 201400404
GET
/integration-notification-webhooks/{notificationId}/failures
Retrieve failed Webhook Notifications for a Webhook using the Notification ID.
getFailedWebhookNotifications 4 params → 200400404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are integrationnotification.WebhookNotificationResponse (7 properties), integrationnotification.WebhookNotificationRequest (6 properties), integrationnotification.MessageResponse (5 properties), integrationnotification.PaginatedWebhookNotificationResponse (5 properties). Each schema is shown below with its type and property counts.

integrationnotification.WebhookNotificationRequest
object
Request object used to create/update a new integration notification.
6 properties 5 required
integrationnotification.PaginatedWebhookFailureResponse
object
5 properties
integrationnotification.PaginatedWebhookNotificationResponse
object
5 properties
integrationnotification.WebhookTypeConfiguration
object
Optional webhook type specific configuration
1 property
integrationnotification.MessageResponse
object
5 properties
integrationnotification.WebhookNotificationResponse
object
Response object for integration notification operations. Contains all common fields from WebhookNotificationRequestBase, along with the notification ID and typ…
7 properties 6 required
integrationnotification.WebhookFailureResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modulr-integration-notification-api-openapi.yml Raw ↑

Other APIs Modulr publishes across the network.

Modulr Access Group API
Modulr Accounts API
Modulr Async API
Modulr Beneficiaries API
Modulr Card Simulator API
Modulr Cards API
Modulr Cards Bulk Operations API
Modulr Channel Manager Card API
Modulr Channel Manager Webhook Notifications API
Modulr Confirmation of Payee API
Modulr Customers API
Modulr Direct Debit Outbound Mandate Operations API
Where this information came from

This is an independent, third-party profile of Modulr Integration Notification API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.