Skip to content
API Reference
/
/
Creates a new subscriptio...

Events Subscriptions API (v1)

Introduction

Welcome to the Aritma Events API!

Over time there will be introduced changes to the API as we continuously introduce improvements. You have the option to use a specific version or the most recent version, supported versions are available in the response header api-supported-versions. Use a specific version of the API by specifying the api-version header, for example api-version: 1.0. If you don't specify the header, the latest version will be used. If a version has been scheduled to be removed, it will be reported through the api-supported-versions header.

Our API uses resource-oriented endpoint paths, accepts Json-Encoded request bodies, returns Json-Encoded responses, and uses standard HTTP response codes and verbs.

Download OpenAPI description
events-openapi.json
events-openapi.yaml
Overview
URL
https://aritma.com/general-inquiry/
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/platform/events/openapi/events-openapi
Subscriptions API Dev
https://events.dev.aritma.io
Subscriptions API
https://events.aritma.io

Deadletter

Operations

Subscriptions

Operations

Creates a new subscription.

Request


Create a subscription for a set of event-types.
To complete provisioning of the subscription you must do a GET request against the validationUrl sent to the Delivery.Url.
Webhooks of the specified event-types will be delivered when provisioning has succeeded.

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

Bodyapplication/json

Aritma.Events.Subscription.Api.Models.Requests.CreateSubscriptionRequest

namestring or null

A unique identifier for the subscription.

Example: "ExampleName"
eventsArray of strings or null

List of events to subscribe to.

Example: ["banking.payment.status.updated","banking.account.transaction.received","banking.account.balance.updated"]
deliveryobject(Delivery)

An object used to configure event delivery properties.

expirationTimestring or null(date-time)

A date and time for when the subscription should expire.

Example: "2024-01-01T00:00:00.000Z"
retryPolicyobject(RetryPolicy)

An object used to configure the retry policy for the subscription.

deadletterEnabledboolean or null

A boolean describing if failed events should be stored in a container.

Example: true
application/json
{
  "name": "ExampleName",
  "events": [
    "banking.payment.status.updated",
    "banking.account.transaction.received",
    "banking.account.balance.updated"
  ],
  "delivery": {
    "url": "https://api.example.com/webhooks/events",
    "maxEventsPerBatch": 10,
    "preferredBatchSizeInKiloBytes": 128,
    "authorizationHeader": "Bearer mF_9.B5f-4.1JqM"
  },
  "expirationTime": "2024-01-01T00:00:00.000Z",
  "retryPolicy": {
    "ttl": "20:00:00",
    "maxEventDeliveryAttempts": 30
  },
  "deadletterEnabled": true
}

Responses

Created

Bodyapplication/json
namestring or null

A unique identifier for the subscription.

Example: "payment-status-webhook"
eventTypesArray of strings or null

List of events to subscribe to.

Example: ["banking.payment.status.updated","banking.account.transaction.received","banking.account.balance.updated"]
deliveryobject(Delivery)

An object used to configure event delivery properties.

expirationDatestring or null(date-time)

A date and time for when the subscription should expire.

retryPolicyobject(RetryPolicy)

An object used to configure the retry policy for the subscription.

deadletterEnabledboolean

A boolean describing if failed events should be stored in a container.

Example: true
provisioningStatestring or null


An event status describing the status for the subscription.
Ok - the subscription is active and operating.
Pending - the subscription is awaiting webhook validation from user.
Processing - the subscription is applying changes, will change status to Ok when done.
Aborted - the last changes was either canceled or failed.

Example: "Ok"
Response
application/json
{
  "name": "payment-status-webhook",
  "eventTypes": [
    "banking.payment.status.updated",
    "banking.account.transaction.received",
    "banking.account.balance.updated"
  ],
  "delivery": {
    "url": "https://api.example.com/webhooks/events",
    "maxEventsPerBatch": 10,
    "preferredBatchSizeInKiloBytes": 128,
    "authorizationHeader": "Bearer mF_9.B5f-4.1JqM"
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "retryPolicy": {
    "ttl": "20:00:00",
    "maxEventDeliveryAttempts": 30
  },
  "deadletterEnabled": true,
  "provisioningState": "Ok"
}

Gets all subscriptions available.

Request

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

No request payload

Responses

Success

Bodyapplication/json
namestring or null

A unique identifier for the subscription.

Example: "payment-status-webhook"
eventTypesArray of strings or null

List of events to subscribe to.

Example: ["banking.payment.status.updated","banking.account.transaction.received","banking.account.balance.updated"]
deliveryobject(Delivery)

An object used to configure event delivery properties.

expirationDatestring or null(date-time)

A date and time for when the subscription should expire.

retryPolicyobject(RetryPolicy)

An object used to configure the retry policy for the subscription.

deadletterEnabledboolean

A boolean describing if failed events should be stored in a container.

Example: true
provisioningStatestring or null


An event status describing the status for the subscription.
Ok - the subscription is active and operating.
Pending - the subscription is awaiting webhook validation from user.
Processing - the subscription is applying changes, will change status to Ok when done.
Aborted - the last changes was either canceled or failed.

Example: "Ok"
Response
application/json
{
  "name": "payment-status-webhook",
  "eventTypes": [
    "banking.payment.status.updated",
    "banking.account.transaction.received",
    "banking.account.balance.updated"
  ],
  "delivery": {
    "url": "https://api.example.com/webhooks/events",
    "maxEventsPerBatch": 10,
    "preferredBatchSizeInKiloBytes": 128,
    "authorizationHeader": "Bearer mF_9.B5f-4.1JqM"
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "retryPolicy": {
    "ttl": "20:00:00",
    "maxEventDeliveryAttempts": 30
  },
  "deadletterEnabled": true,
  "provisioningState": "Ok"
}

Gets a subscription matching the id specified.

Request

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Path
subscriptionNamestringrequired

The unique name of the subscription.

Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

No request payload

Responses

Success

Bodyapplication/json
namestring or null

A unique identifier for the subscription.

Example: "payment-status-webhook"
eventTypesArray of strings or null

List of events to subscribe to.

Example: ["banking.payment.status.updated","banking.account.transaction.received","banking.account.balance.updated"]
deliveryobject(Delivery)

An object used to configure event delivery properties.

expirationDatestring or null(date-time)

A date and time for when the subscription should expire.

retryPolicyobject(RetryPolicy)

An object used to configure the retry policy for the subscription.

deadletterEnabledboolean

A boolean describing if failed events should be stored in a container.

Example: true
provisioningStatestring or null


An event status describing the status for the subscription.
Ok - the subscription is active and operating.
Pending - the subscription is awaiting webhook validation from user.
Processing - the subscription is applying changes, will change status to Ok when done.
Aborted - the last changes was either canceled or failed.

Example: "Ok"
Response
application/json
{
  "name": "payment-status-webhook",
  "eventTypes": [
    "banking.payment.status.updated",
    "banking.account.transaction.received",
    "banking.account.balance.updated"
  ],
  "delivery": {
    "url": "https://api.example.com/webhooks/events",
    "maxEventsPerBatch": 10,
    "preferredBatchSizeInKiloBytes": 128,
    "authorizationHeader": "Bearer mF_9.B5f-4.1JqM"
  },
  "expirationDate": "2019-08-24T14:15:22Z",
  "retryPolicy": {
    "ttl": "20:00:00",
    "maxEventDeliveryAttempts": 30
  },
  "deadletterEnabled": true,
  "provisioningState": "Ok"
}

Updates an existing subscription matching the id specified.

Request


Updates a subscription for a set of event-types.
To complete provisioning of the subscription you must do a GET request against the validationUrl sent to the Delivery.Url.
Webhooks of the specified event-types will be delivered when provisioning has succeeded.

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Path
subscriptionNamestringrequired

The unique identifier of a subscription.

Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

Bodyapplication/json

A Aritma.Events.Subscription.Api.Models.Requests.UpdateSubscriptionRequest object used to Update a subscription.

eventsArray of strings or null

List of events to subscribe to.

Example: ["banking.payment.status.updated","banking.account.transaction.received","banking.account.balance.updated"]
deliveryobject(Delivery)

An object used to configure event delivery properties.

expirationTimestring or null(date-time)

A date and time for when the subscription should expire.

retryPolicyobject(RetryPolicy)

An object used to configure the retry policy for the subscription.

deadletterEnabledboolean or null

A boolean describing if failed events should be stored in a container.

Example: true
application/json
{
  "events": [
    "banking.payment.status.updated",
    "banking.account.transaction.received",
    "banking.account.balance.updated"
  ],
  "delivery": {
    "url": "https://api.example.com/webhooks/events",
    "maxEventsPerBatch": 10,
    "preferredBatchSizeInKiloBytes": 128,
    "authorizationHeader": "Bearer mF_9.B5f-4.1JqM"
  },
  "expirationTime": "2019-08-24T14:15:22Z",
  "retryPolicy": {
    "ttl": "20:00:00",
    "maxEventDeliveryAttempts": 30
  },
  "deadletterEnabled": true
}

Responses

Success

Bodyapplication/json
provisioningStatestring or null
Response
application/json
{
  "provisioningState": "string"
}

Deletes an existing subscription matching the id specified.

Request

Security
authorization_code_dev(Required scopes:
api
) or client_credentials_dev(Required scopes:
api
) or authorization_code(Required scopes:
api
) or client_credentials(Required scopes:
api
)
Path
subscriptionNamestringrequired

The unique name of a subscription.

Headers
ResourceUristring

ResourceUri to create the event subscriptions under.

TenantIdstring(uuid)

TenantId used by the customer.

No request payload

Responses

No Content

Response
No content