Skip to main content
POST
/
notifications
/
webhooks
Create a new webhook profile
curl --request POST \
  --url https://api-sb.meld.io/notifications/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>"
}
'
{
  "accountId": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "eventVersion": "<string>",
  "id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "secret": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
default:BASIC <Meld API Key>
required

Body

application/json
​
name
string
required

Display name

Minimum string length: 1
​
url
string
required

URL where webhooks will be sent

Minimum string length: 1
​
eventTypes
enum<string>[]

Event types that will be sent to the URL. If empty, then all events will be sent to the URL.

Reference Webhook events

Available options:
TRANSACTION_CRYPTO_PENDING,
TRANSACTION_CRYPTO_FAILED,
TRANSACTION_CRYPTO_TRANSFERRING,
TRANSACTION_CRYPTO_COMPLETE,
TRANSACTION_FIAT_CREATED,
TRANSACTION_FIAT_UPDATED,
BANK_LINKING_CONNECTION_COMPLETED,
BANK_LINKING_CONNECTION_DELETED,
BANK_LINKING_CONNECTION_STATUS_CHANGE,
BANK_LINKING_ACCOUNTS_ADDED,
BANK_LINKING_ACCOUNTS_UPDATING,
BANK_LINKING_ACCOUNTS_UPDATED,
BANK_LINKING_ACCOUNTS_REMOVED,
BANK_LINKING_TRANSACTIONS_AGGREGATED,
BANK_LINKING_HISTORICAL_TRANSACTIONS_AGGREGATED,
BANK_LINKING_NEW_ACCOUNTS_AVAILABLE,
CUSTOMER_KYC_STATUS_CHANGE,
TEST,
WEBHOOK_TEST
​
eventVersion
string

Version of webhooks sent to the URL. If not specified, the current date will be used.

Reference Webhook version

Response

Webhook profile created

​
accountId
string

Account Id

​
eventTypes
string[]

Event types that will be sent to the URL. If empty, then all events will be sent to the URL.

Reference Webhook events

​
eventVersion
string

Version of webhooks sent to the URL.

Reference Webhook version

​
id
string

Unique identifier

​
key
string

Unique key corresponding to a webhook profile's position in a paginated list of results. Only present if this webhook profile is in a paginated response.

Reference Pagination

​
name
string

Display name

​
secret
string

Secret used to validate authenticity of a webhook.

Reference Webhook authentication

​
status
enum<string>

Current status

Available options:
ACTIVE,
DISABLED
​
url
string

URL where webhooks will be sent