queues

Listen to events on a specific queue

[Protected by one of the following scopes : connections_manage or connections_sync] This endpoint allows you to retrieve information from a queue

get/queues/{id}

Request

  • Base URL: https://api.linxo.com/v2
  • URL: https://api.linxo.com/v2/queues/{id}
  • Auth: OAuth (defined in the document in a form this page cannot read)

Path parameters

idstring required

Query parameters

flush_fromnumber

Deletes all events prior to the value provided.

resource_typestring

Filter events by resource type (CONNECTION or PAYMENT). You can filter one resource_type (resource_type=CONNECTION) or a list of resource_type (resource_type=CONNECTION,PAYMENT)

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Response

Queue successfully retrieved

idstring required

The unique event identifier. The value of this property corresponds to the value provided in the URL.

channel_definition_idstring

The channel definition unique identifier the event is related to

creation_datestring date required

Creation date as UTC timestamp in seconds

event_type'LIST_ACCOUNTS_SUCCESS' | 'LIST_ACCOUNTS_FAILURE' | 'LIST_ACCOUNTS_STARTED' | 'LIST_ACCOUNTS_LOGGING_IN' | 'LIST_ACCOUNTS_CREDENTIALS_VALIDATED' | 'LIST_ACCOUNTS_LOGGED_IN' | 'LIST_ACCOUNTS_READING_ACCOUNT_LIST' | 'LIST_ACCOUNTS_READING_ACCOUNT' | 'LIST_ACCOUNTS_FINISHED_ACCOUNT' | 'LIST_ACCOUNTS_ACCOUNT_FAILURE' | 'LIST_ACCOUNTS_ACCOUNT_NOT_FOUND' | 'LIST_ACCOUNTS_TRANSACTION_READ' | 'LIST_ACCOUNTS_LOGGING_OUT' | 'LIST_ACCOUNTS_USER_INPUT_REQUESTED' | 'SYNC_ALL_SUCCESS' | 'SYNC_ALL_FAILURE' | 'SYNC_ALL_STARTED' | 'SYNC_ALL_LOGGING_IN' | 'SYNC_ALL_CREDENTIALS_VALIDATED' | 'SYNC_ALL_LOGGED_IN' | 'SYNC_ALL_READING_ACCOUNT_LIST' | 'SYNC_ALL_READING_ACCOUNT' | 'SYNC_ALL_FINISHED_ACCOUNT' | 'SYNC_ALL_ACCOUNT_FAILURE' | 'SYNC_ALL_ACCOUNT_NOT_FOUND' | 'SYNC_ALL_TRANSACTION_READ' | 'SYNC_ALL_LOGGING_OUT' | 'SYNC_ALL_USER_INPUT_REQUESTED' | 'PAYMENT_SUCCESS' | 'PAYMENT_FAILURE' | 'PAYMENT_STARTED' | 'PAYMENT_LOGGING_IN' | 'PAYMENT_CREDENTIALS_VALIDATED' | 'PAYMENT_LOGGED_IN' | 'PAYMENT_USER_INPUT_REQUESTED' | 'PAYMENT_INITIATING' | 'PAYMENT_PENDING' required

The type of event prefixed by the the type of job.

Prefix List:

  • SYNC_ALL - Events created during a normal synchronization
  • LIST_ACCOUNTS - Events created during a LIST_ACCOUNTS synchronization
  • PAYMENT - Events created during a payment action

Event types :

  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_STARTED - This event informs that job has begun
  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_LOGGING_IN - This event informs that the connection to the service provider is in progress
  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_CREDENTIALS_VALIDATED - This event informs that the credentials have been validated by the service provider
  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_LOGGED_IN - This event informs that the connection has successfully connected to the service provider
  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_USER_INPUT_REQUESTED - This event informs that the connection requires a response to a challenge sent by the service provider
  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_SUCCESS - This event informs that job has finished successfully
  • [SYNC_ALL|LIST_ACCOUNTS|PAYMENT]_FAILURE - This event informs that job has failed. More information is available in the resource property

Event types specific to SYNC_ALL and LIST_ACCOUNTS

  • [SYNC_ALL|LIST_ACCOUNTS]_READING_ACCOUNT_LIST - This event informs that the connection is browsing the list of accounts
  • [SYNC_ALL|LIST_ACCOUNTS]_READING_ACCOUNT - This event informs that the connection is browsing an account
  • [SYNC_ALL|LIST_ACCOUNTS]_FINISHED_ACCOUNT - This event informs that the connection has finished browsing an account
  • [SYNC_ALL|LIST_ACCOUNTS]_ACCOUNT_FAILURE - This event informs that the connection failed on an account
  • [SYNC_ALL|LIST_ACCOUNTS]_ACCOUNT_NOT_FOUND - This event informs you that the account has not been found
  • [SYNC_ALL|LIST_ACCOUNTS]_TRANSACTION_READ - This event informs you that the account is browsing the information for a transaction
  • [SYNC_ALL|LIST_ACCOUNTS]_LOGGING_OUT - This event informs that the connection is disconnected from the service provider

Event types specific to PAYMENT :

  • PAYMENT_INITIATING - This event reports that the payment is starting
  • PAYMENT_PENDING - This event reports that the payment is pending
resource_type'CONNECTION' | 'PAYMENT' required

Type of the resource associated to the event.

resourceQueueResource required

The resource associated with this event

Changes

No recorded changes to this operation across all 1 revision of this API.