Create Subscriber

post

https://api.cloud.mbanq.com/v1/subscribers

Use this API to add a new subscriber for a webhook, email, or client email.

The creation of a subscriber registers a target URL or email where JSON payloads will be delivered for different entities and associated actions.

This API is essential for setting up notifications and ensuring that the specified targets receive the necessary updates.

Body Params

name

string

required

Defaults to Client Webhook

Name of the subscriber
Example: Client Webhook

type

string

enum

required

Defaults to WEBHOOK

Type of subscriber
Example: WEBHOOK

Allowed:

active

boolean

Indicates whether the subscriber should be active or not after creation.
If not provided, defaults to true.
Example: true

target

string

Email/Url where the email/webhook should be sent.
Required for EMAIL and WEBHOOK subscriber types. Optional for CLIENT_EMAIL, PUSH_NOTIFICATION, and CORE_EVENT_PROCESSOR types.
Example: https://bank.site/webhook/client

secretKey

string

Secret key for the authorization header to be sent with webhook
Example: 23b08ae3-1c5a-40b2-9c4a-31db193ff430

deliveryRetryLimit

integer

≥ 1

Maximum number of retry attempts for failed deliveries.
If not provided, defaults to 3. Must be greater than 0 if specified.
Example: 3

headers

array of objects

Array of custom headers to be sent as part of the webhook request.
Each header object must contain both 'name' and 'value' fields.

headers

Headers

tenantId

string

required

The ID of your banking instance visible in the MBANQ Console.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The Subscriber is added successfully.