Skip to main content
GET
get-external-event-subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

external-event-subscription id.

Response

200 - application/json

Read a single external-event-subscription by id.

userId
string
required
id
string
required
tenantId
string
ownerName
string | null
name
string
description
string
connectionId
string
integrationId
string
externalEventTypeId
string
config
object
status
enum<string>
Available options:
subscribed,
unsubscribed,
error
error
object
state
enum<string>
Available options:
BUILDING,
CLIENT_ACTION_REQUIRED,
CONFIGURATION_ERROR,
SETUP_FAILED,
READY,
DISCONNECTING
buildingAgentSessionId
string
isRealTime
boolean
requiresPull
boolean
requiresFullSync
boolean
createdAt
string
archivedAt
string
isDeactivated
boolean
stateData
any
nextPullEventsTimestamp
number
pullUpdatesIntervalSeconds
number
fullSyncIntervalSeconds
number
nextRefreshTimestamp
number
incomingWebhookUri
string
subscribedWebhookUri
string
lastReceivedAt
any
lastEventAt
any
webhookUri
string
logoUri
string

Resolved app logo for this element (integration -> connector -> external app -> favicon).