Create Webhook Subscription

POST

/api/webhook/subscriptions

Remember that in addition to the API key, you will need to sign the request. API Security and Authentication

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://baas-api.np.bankei.com.br/api/webhook/subscriptions' \
--header 'x-signature: ' \
--header 'x-timestamp: ' \
--header 'x-endpoint: ' \
--header 'x-org-id: ' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://your-api.com.br/path",
    "organizationId": "...",
    "subscription": "open-internal-account"
}'

Response Example

{}

Modified at 2026-01-12 11:55:38

Bill Payment Webhook Events

Get Webhook Subscriptions