PApaperlessparts
Events

Returns a list of new events

Returns a list of events that have not yet been dispatched for the managed integration.

get/managed_integrations/public/{managed_integration_uuid}/poll

Request

Path parameters

managed_integration_uuidstring required

The unique identifier for the managed integration whose events you want to poll

Query parameters

create_dispatch_recordsstring

Whether you would like to create associated dispatch records for all events returned for this page. If set to true (or left unspecified), the events returned will not show up in the next response from this endpoint.

event_type_instring

Filter to return events of a specified event type

was_dispatchedstring

Filter to return only events that have associated dispatch records

Response

Successful response

uuidstring uuid
typestring

The event type

dataobject

Data relevant to the event

related_objectstring uuid nullable
related_object_typestring
createdstring

Example response

[
  {
    "type": "integration_action.requested",
    "created": "2020-08-25T18:00:53+00:00"
  }
]

Changes

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