Skip to main content

​
Create a webhook

POST /v2/webhooks

​
Request

Use this request to create a new webhook for a given webhookEventTypeName or webhookEventTypeId. 
curl -i -X POST \
  https://api.equalsmoney.com/v2/webhooks \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sharedSecret": "123e4567-e89b-12d3-a456-426614174100",
    "enabled": true,
    "accountId": "F12345", 
    "webhookEventTypeName": "AccountActivated",
    "url": "YOUR_WEBHOOK_URL",
    "authorizationHeader": "YOUR_AUTHORIZATION_HEADER"
  }'

​
Request body schema

​
sharedSecret
string (uuid)
When provided, we use this to generate a hash-based message authentication code (HMAC) using the SHA-256 algorithm. We Base64 encode this signature. Every event notification you receive for this webhook will include an x-em-signature header, if a shared secret has been provided. You can use this to verify the integrity and authenticity of the message.Allowable values: ≤ 36 characters
​
enabled
boolean
required
Whether or not the webhook should be enabled.Allowable values: true, false
​
accountId
string or null
The ID of the account.Allowable values: A valid accountId
​
webhookEventTypeName
string (uuid)
required
The name of the webhook event type that you want to create a webhook for.Allowable values: AccountCreated, AccountActivated, RecipientCreated, RecipientDeleted, BoxCredited, BoxDebited, OrderCreated, OrderCompleted, OrderCancelled, FeeCreated, 3DSAuthRequest, CardTransaction, DigitalWalletTokenTransition
​
webhookEventTypeId
string (uuid)
required
The ID of the webhook event type that you want to create a webhook for.Allowable values: ≤ 36 characters
​
url
string
required
The URL of your webhook endpoint.Allowable values: ≤ 512 characters
​
authorizationHeader
string or null
The authorisation header content for the webhook.Allowable values: ≤ 512 characters

​
Response

{
  "sharedSecret": "123e4567-e89b-12d3-a456-426614174000",
  "enabled": true,
  "accountId": "F12345",
  "webhookEventTypeId": "a4dcc403-41aa-4f2e-acf6-32dbaec78e72",
  "url": "https://api.url.com",
  "authorizationHeader": "Basic AXVubzpwQDU1dzByYM==",
  "id": "a4dcc403-41aa-4f2e-acf6-32dbaec78e72",
  "productId": "911db6db-ef58-4992-87cd-2fe2cfde05f9",
  "webhookEventTypeName": "AccountActivated",
  "createdAt": "2023-01-30T08:30:00Z",
  "updatedAt": "2023-01-30T08:30:00Z"
}
For more detailed information about this request and its response, see the API reference.