Membrane React - v0.6.0
Console
SDK
REST API
Preparing search index...
useAppEventSubscription
Function useAppEventSubscription
useAppEventSubscription
(
selector
:
undefined
|
string
|
AppEventSubscriptionSelector
,
)
:
{
appEventSubscription
:
|
undefined
|
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
appEventTypeId
:
string
;
userId
:
string
;
instanceKey
?:
string
;
isSubscribed
:
boolean
;
schema
?:
DataSchema
;
webhookUri
:
string
;
subscriptionRequest
:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
subscriptionResponse
?:
any
;
archivedAt
?:
string
;
appEventType
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
archivedAt
?:
string
;
subscribeRequest
?:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
example
?:
any
;
schema
?:
DataSchema
;
globalWebhookUri
:
string
;
userIdFormula
?:
any
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
}
;
accessor
:
undefined
|
AppEventSubscriptionAccessor
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refresh
:
()
=>
Promise
<
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
appEventTypeId
:
string
;
userId
:
string
;
instanceKey
?:
string
;
isSubscribed
:
boolean
;
schema
?:
DataSchema
;
webhookUri
:
string
;
subscriptionRequest
:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
subscriptionResponse
?:
any
;
archivedAt
?:
string
;
appEventType
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
archivedAt
?:
string
;
subscribeRequest
?:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
example
?:
any
;
schema
?:
DataSchema
;
globalWebhookUri
:
string
;
userIdFormula
?:
any
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
}
,
>
;
refreshing
:
boolean
;
create
:
(
data
:
AppEventSubscriptionUpdateRequest
,
)
=>
Promise
<
|
undefined
|
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
appEventTypeId
:
string
;
userId
:
string
;
instanceKey
?:
string
;
isSubscribed
:
boolean
;
schema
?:
DataSchema
;
webhookUri
:
string
;
subscriptionRequest
:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
subscriptionResponse
?:
any
;
archivedAt
?:
string
;
appEventType
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
archivedAt
?:
string
;
subscribeRequest
?:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
(...)
,
(...)
>
;
query
?:
Record
<
(...)
,
(...)
>
;
body
?:
any
;
}
;
example
?:
any
;
schema
?:
DataSchema
;
globalWebhookUri
:
string
;
userIdFormula
?:
any
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
}
,
>
;
patch
:
(
data
:
Partial
<
UpdateRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
AppEventSubscriptionUpdateRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Parameters
selector
:
undefined
|
string
|
AppEventSubscriptionSelector
Returns
{
appEventSubscription
:
|
undefined
|
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
appEventTypeId
:
string
;
userId
:
string
;
instanceKey
?:
string
;
isSubscribed
:
boolean
;
schema
?:
DataSchema
;
webhookUri
:
string
;
subscriptionRequest
:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
subscriptionResponse
?:
any
;
archivedAt
?:
string
;
appEventType
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
archivedAt
?:
string
;
subscribeRequest
?:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
example
?:
any
;
schema
?:
DataSchema
;
globalWebhookUri
:
string
;
userIdFormula
?:
any
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
}
;
accessor
:
undefined
|
AppEventSubscriptionAccessor
;
loading
:
boolean
;
saving
:
boolean
;
error
:
any
;
refresh
:
()
=>
Promise
<
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
appEventTypeId
:
string
;
userId
:
string
;
instanceKey
?:
string
;
isSubscribed
:
boolean
;
schema
?:
DataSchema
;
webhookUri
:
string
;
subscriptionRequest
:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
subscriptionResponse
?:
any
;
archivedAt
?:
string
;
appEventType
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
archivedAt
?:
string
;
subscribeRequest
?:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
example
?:
any
;
schema
?:
DataSchema
;
globalWebhookUri
:
string
;
userIdFormula
?:
any
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
}
,
>
;
refreshing
:
boolean
;
create
:
(
data
:
AppEventSubscriptionUpdateRequest
,
)
=>
Promise
<
|
undefined
|
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
appEventTypeId
:
string
;
userId
:
string
;
instanceKey
?:
string
;
isSubscribed
:
boolean
;
schema
?:
DataSchema
;
webhookUri
:
string
;
subscriptionRequest
:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
string
,
any
>
;
query
?:
Record
<
string
,
any
>
;
body
?:
any
;
}
;
subscriptionResponse
?:
any
;
archivedAt
?:
string
;
appEventType
?:
{
id
:
string
;
key
?:
string
;
uuid
?:
string
;
description
?:
string
;
meta
?:
Record
<
string
,
any
>
;
name
:
string
;
state
?:
CONFIGURATION_ERROR
|
SETUP_FAILED
|
READY
;
errors
?:
ErrorDataSchema
[]
;
createdAt
?:
string
;
updatedAt
?:
string
;
isDeactivated
?:
boolean
;
revision
:
string
;
archivedAt
?:
string
;
subscribeRequest
?:
{
method
?:
GET
|
POST
|
PATCH
|
PUT
|
DELETE
;
uri
:
any
;
headers
?:
Record
<
(...)
,
(...)
>
;
query
?:
Record
<
(...)
,
(...)
>
;
body
?:
any
;
}
;
example
?:
any
;
schema
?:
DataSchema
;
globalWebhookUri
:
string
;
userIdFormula
?:
any
;
}
;
user
?:
{
id
:
string
;
name
:
string
;
meta
?:
Record
<
string
,
any
>
;
internalId
:
string
;
fields
?:
Record
<
string
,
any
>
;
credentials
?:
any
;
lastActiveAt
?:
string
;
isTest
?:
boolean
;
isBillable
?:
boolean
;
createdAt
?:
string
;
archivedAt
?:
string
;
}
;
}
,
>
;
patch
:
(
data
:
Partial
<
UpdateRequest
>
)
=>
Promise
<
void
>
;
put
:
(
data
:
AppEventSubscriptionUpdateRequest
)
=>
Promise
<
void
>
;
archive
:
()
=>
Promise
<
void
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Console
SDK
REST API
Membrane React - v0.6.0
Loading...