Get webhook event type details

Get of list of webhook event types or retrieve details about a specific webhook event type.

List webhook event types

Get/v2/webhooks/event-types

Request

Use this request to retrieve a list of webhook event types.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/webhooks' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/webhooks' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Query parameters

Parameter	Description
`accountId` string	The account ID to filter the response with. This is required if you have a user-level API key. Allowable values: An existing `accountId` (<= 36 characters)

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure

Copy

Copied

[
  {
    "id": "2704f4e3-7790-43a0-905c-e0a6aaf89cdd",
    "name": "3DSAuthRequest",
    "enabled": true,
    "createdAt": "2023-04-14T15:08:58.000Z",
    "updatedAt": "2023-04-19T09:11:10.000Z"
  },
  {
    "id": "a4dcc403-41aa-4f2e-acf6-32dbaec78e72",
    "name": "AccountActivated",
    "enabled": true,
    "createdAt": "2023-04-04T10:02:56.000Z",
    "updatedAt": "2023-04-04T10:02:56.000Z"
  },
  {
    "id": "7e71bf60-40f3-489f-bd09-e03035d5cd0a",
    "name": "AccountCreated",
    "enabled": true,
    "createdAt": "2023-03-29T12:46:41.000Z",
    "updatedAt": "2023-03-29T12:46:41.000Z"
  },
  {
    "id": "25d5b682-7449-4d07-b6fc-7c9bf1239561",
    "name": "BoxCredited",
    "enabled": true,
    "createdAt": "2022-10-26T12:31:47.000Z",
    "updatedAt": "2022-10-26T12:31:47.000Z"
  },
  {
    "id": "fc05160e-0f0c-44e0-87a8-e2f093b09ff4",
    "name": "BoxDebited",
    "enabled": true,
    "createdAt": "2022-12-22T11:24:39.000Z",
    "updatedAt": "2022-12-22T11:24:39.000Z"
  },
  {
    "id": "a1920089-8cdd-404d-b1aa-624bc4170b40",
    "name": "CardStateUpdated",
    "enabled": true,
    "createdAt": "2023-10-18T15:17:40.000Z",
    "updatedAt": "2023-10-18T15:17:40.000Z"
  },
  {
    "id": "da153b21-9c8d-46d2-8911-83c6da10655a",
    "name": "CardTransaction",
    "enabled": true,
    "createdAt": "2023-03-14T12:06:10.000Z",
    "updatedAt": "2023-05-16T10:48:23.000Z"
  },
  {
    "id": "06e852d1-fcd5-43e6-babe-65a06a43266b",
    "name": "OrderCancelled",
    "enabled": true,
    "createdAt": "2022-10-26T12:31:47.000Z",
    "updatedAt": "2022-10-26T12:31:47.000Z"
  },
  {
    "id": "64b18e0e-4561-4509-ad35-ecc8d342d291",
    "name": "RecipientCreated",
    "enabled": true,
    "createdAt": "2022-10-26T12:31:47.000Z",
    "updatedAt": "2023-01-04T15:19:37.000Z"
  },
  {
    "id": "ed6dfe0e-6cf2-43d5-9f35-aebf873f4e77",
    "name": "RecipientDeleted",
    "enabled": true,
    "createdAt": "2022-10-26T12:31:47.000Z",
    "updatedAt": "2022-10-26T12:31:47.000Z"
  },
  {
    "id": "f1c61286-49e0-42ae-a4d1-281c1ecb0ca4",
    "name": "RecipientUpdated",
    "enabled": true,
    "createdAt": "2022-10-26T12:31:47.000Z",
    "updatedAt": "2022-10-26T12:31:47.000Z"
  }
]

Copy

Copied

[
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "da153b21-9c8d-46d2-8911-83c6da10655a",
    "name": "CardTransaction",
    "enabled": true,
    "createdAt": "2023-03-14T12:06:10.000Z",
    "updatedAt": "2023-05-16T10:48:23.000Z"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  },
  {
    "id": "string",
    "name": "string",
    "enabled": boolean,
    "createdAt": "string",
    "updatedAt": "string"
  }
]

For more detailed information about this request and its response, see the API reference.

Retrieve a webhook event type

Get/v2/webhooks/event-types/{webhookEventTypeId}

Request

Use this request to get details about a given webhook event type, based on its webhookEventTypeId.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/webhooks/event-types/99d77c0c-2c95-4f87-a7a5-ce12898a9672' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/v2/webhooks/event-types/{webhookEventTypeId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

Parameter	Description
`webhookEventTypeId` string required	The ID of the webhook event type that you want to retrieve. Allowable values: An existing `webhookEventTypeId` (<= 36 characters)

Query parameters

Parameter	Description
`accountId` string	The account ID to filter the response with. This is required if you have a user-level API key. Allowable values: An existing `accountId` (<= 36 characters)

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure

Copy

Copied

{
  "id": "99d77c0c-2c95-4f87-a7a5-ce12898a9672",
  "name": "AccountCreated",
  "enabled": true,
  "createdAt": "2023-01-30T08:30:00Z",
  "updatedAt": "2023-01-30T08:30:00Z"
}

Copy

Copied

{
{
  "id": "string",
  "name": "string",
  "enabled": boolean,
  "createdAt": "string",
  "updatedAt": "string"
}

For more detailed information about this request and its response, see the API reference.