API docs by Redocly

Event API (0.1.0)

Download OpenAPI specification:Download

API for managing subscriptions and events.

Frontier Integration Platform utilises Event-based patterns for asynchronous integration to any available product, all changes to data, partnerships, etc. will trigger an event of varying types. These are designed to be consumed by both consumer and providers of a partnership through the use of subscriptions.

Event Management

Poll Subscription

Get new events which are added to the queue.

path Parameters
subscription_id
required
string (Subscription Id)

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Confirm Event

This is used to confirm you have received the event, and removes it from the queue.

path Parameters
subscription_id
required
string (Subscription Id)
header Parameters
Receipt Handle (string) or Receipt Handle (null) (Receipt Handle)
Receipt-Handle (string) or Receipt-Handle (null) (Receipt-Handle)

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Subscription

Create/Update Subscription

Updates a subscription by ID, if the subscription doesn't exist it is created

path Parameters
subscription_id
required
string (Subscription Id)
Request Body schema: application/json
required
required
Array of objects (Subscriptiondetail)

List of subscription details

Webhook (string) or Webhook (null) (Webhook)

webhook url for this subscription callback

Responses

Request samples

Content type
application/json
{
  • "subscriptionDetail": [
    ],
  • "webhook": "string"
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Delete Subscription

Deletes a subscription by ID for your organisation.

path Parameters
subscription_id
required
string (Subscription Id)

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get Subscription

Gets details of a subscription by ID.

path Parameters
subscription_id
required
string (Subscription Id)

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get All Subscriptions

Gets all your organisation's subscriptions.

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Monitoring

Get Subscription Metrics

path Parameters
subscription_id
required
string (Subscription Id)
query Parameters
start_time
string <date-time> (Start Time)

Start time for metrics

end_time
string <date-time> (End Time)

End time for metrics

interval
integer (Interval)

Interval for metrics

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}