Applications

Create application

post /api/http/applications

Rights, that may be checked: Create applications

Request arguments

object with fields:

name: string
pictureAttachmentId: string ( Nullable and Optional , defaults to null)
defaultExternalPicture: string ( Nullable and Optional , defaults to null)
clientId: string ( Nullable and Optional , defaults to null)
clientSecret: string ( Nullable and Optional , defaults to null)
clientCredentialsFlowEnabled: boolean ( Nullable and Optional , defaults to null)
codeFlowEnabled: boolean ( Nullable and Optional , defaults to null)
codeFlowRedirectURIs: string ( Nullable and Optional , defaults to null)
pkceRequired: boolean ( Nullable and Optional , defaults to null)
implicitFlowEnabled: boolean ( Nullable and Optional , defaults to null)
implicitFlowRedirectURIs: string ( Nullable and Optional , defaults to null)
endpointUri: string ( Nullable and Optional , defaults to null)
endpointSslVerification: boolean ( Optional , defaults to true)
appLevelAuth: EndpointAuthCreate ( Nullable and Optional , defaults to null)
sslKeystoreAuth: string ( Nullable and Optional , defaults to null)
hasSigningKey: boolean ( Nullable and Optional , defaults to null)
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
hasPublicKeySignature: boolean ( Nullable and Optional , defaults to null)
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
basicAuthUsername: string ( Nullable and Optional , defaults to null)
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
basicAuthPassword: string ( Nullable and Optional , defaults to null)
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
bearerAuthToken: string ( Nullable and Optional , defaults to null)
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
connectToSpace: boolean ( Nullable and Optional , defaults to false)
state: string ( Nullable and Optional , defaults to null)

Response
`ES_App`

Restore application

post /api/http/applications/{application}/restore

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
No arguments

Get all applications

get /api/http/applications/paged

Rights, that may be checked: View applications

Request arguments
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`name`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`owner`: array of `ProfileIdentifier` (Query) ( Nullable and Optional , defaults to `null`)
`withArchived`: `boolean` (Query) ( Nullable and Optional , defaults to `false`)
`withManaged`: `boolean` (Query) ( Nullable and Optional , defaults to `true`)
`ordering`: `AppsOrdering` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of ES_App

Get application

get /api/http/applications/{application}

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`ES_App`

Update application

patch /api/http/applications/{application}

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)
pictureAttachmentId: string ( Nullable and Optional )
defaultExternalPicture: string ( Nullable and Optional )
clientSecret: string ( Nullable and Optional , defaults to null)
clientCredentialsFlowEnabled: boolean ( Nullable and Optional , defaults to null)
codeFlowEnabled: boolean ( Nullable and Optional , defaults to null)
codeFlowRedirectURIs: string ( Nullable and Optional )
pkceRequired: boolean ( Nullable and Optional , defaults to null)
implicitFlowEnabled: boolean ( Nullable and Optional , defaults to null)
implicitFlowRedirectURIs: string ( Nullable and Optional )
endpointUri: string ( Nullable and Optional )
endpointSslVerification: boolean ( Optional )
hasVerificationToken: boolean ( Optional )
Deprecated since 2021-09-02: VerificationToken is an obsolete auth method - use it to turn it off. It will be removed in a future version.
hasPublicKeySignature: boolean ( Optional )
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
hasSigningKey: boolean ( Optional )
Deprecated since 2021-09-02: Use appLevelAuth instead. It will be removed in a future version.
appLevelAuth: EndpointAppLevelAuthUpdateType ( Optional )
sslKeystoreAuth: string ( Nullable and Optional )
basicAuthUsername: string ( Optional )
basicAuthPassword: string ( Optional )
bearerAuthToken: string ( Optional )

Response
`ES_App`

Delete application

delete /api/http/applications/{application}

Rights, that may be checked: Delete applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
No arguments

Bearer token

get /api/http/applications/{application}/bearer-token

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`string`

Get last client credentials access info

get /api/http/applications/{application}/last-client-credentials-access

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`AccessRecord`

Public keys

get /api/http/applications/{application}/public-keys

Returns list of public keys in JWKS format. If message signature is successfully verified with any of the returned public keys, the message can be considered authentic.

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`string`

Set ui extensions

patch /api/http/applications/ui-extensions

Set UI extensions supported by the calling application in specified context. Only the application itself can set its extensions.

Request arguments

object with fields:

contextIdentifier: PermissionContextIdentifier
extensions: array of AppUiExtensionIn

Response
No arguments

Get applications authorized in context

get /api/http/applications/authorizations/authorized-applications

List applications authorized in specified context

Rights, that may be checked: View applications

Request arguments

contextIdentifier: string in one of the formats

channel: string
folder: string
document: string
global
profile: ProfileIdentifier
project: ProjectIdentifier
team: TeamIdentifier

(Query)

Response
array of `ES_App`

Update unfurled domains

patch /api/http/applications/unfurls/domains

Update list of domains for unfurling by the application. Method is to be called by the application providing unfurls.

Rights, that may be checked: Update applications

Request arguments

object with fields:

domains: array of string

Response
No arguments

Update unfurled patterns

patch /api/http/applications/unfurls/patterns

Update list of external ID prefixes for unfurling by the application. Method is to be called by the application providing unfurls.

Rights, that may be checked: Update applications

Request arguments

object with fields:

patterns: array of ApplicationUnfurlPatternRequest

Response
No arguments

Post unfurls content

post /api/http/applications/unfurls/queue/content

Provide Space with unfurls content. Method is to be called by the application providing unfurls.

Rights, that may be checked: Provide external unfurls as attachments

Request arguments

object with fields:

unfurls: array of ApplicationUnfurl

Response
array of `PostUnfurlContentResult`

Request external system authentication

post /api/http/applications/unfurls/queue/request-external-auth

Request user to authenticate in external system to provide unfurls from it. Method is to be called by the application providing unfurls.

Rights, that may be checked: Provide external unfurls as attachments

Request arguments

object with fields:

queueItemId: string
message: ApplicationUnfurlContent.Message

Response
No arguments

Clear external system authentication requests

post /api/http/applications/unfurls/queue/reset-external-auth-requests

Clear all external system authentication requests for the specified user. Method is to be called by the application providing unfurls.

Rights, that may be checked: Provide external unfurls as attachments

Request arguments

object with fields:

userId: ProfileIdentifier

Response
No arguments

Get unfurl queue items

get /api/http/applications/unfurls/queue

Get links for unfurling by the application. Method is to be called by the application providing unfurls.

Rights, that may be checked: Provide external unfurls as attachments

Request arguments
`fromEtag`: `integer` (format: int64) (Query) ( Nullable and Optional , defaults to `null`)
`batchSize`: `integer` (format: int32) (Query)

Response
array of `ApplicationUnfurlQueueItem`

Get all authorized contexts

get /api/http/applications/{application}/authorizations/authorized-contexts

List authorized contexts of an application

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
array of `PermissionContextApi`

Get all authorized rights

get /api/http/applications/{application}/authorizations/authorized-rights

List authorized rights of an application in specified context

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

contextIdentifier: string in one of the formats

channel: string
folder: string
document: string
global
profile: ProfileIdentifier
project: ProjectIdentifier
team: TeamIdentifier

(Query)

Response
array of `RightDTO`

Update authorized right

patch /api/http/applications/{application}/authorizations/authorized-rights

Generic method for editing authorized right status in given context.

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

contextIdentifier: PermissionContextIdentifier
updates: array of RightUpdateDTO

Response
No arguments

Delete authorized right

delete /api/http/applications/{application}/authorizations/authorized-rights

Remove application authorization in specified context

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

contextIdentifier: string in one of the formats

channel: string
folder: string
document: string
global
profile: ProfileIdentifier
project: ProjectIdentifier
team: TeamIdentifier

(Query)

Response
No arguments

Request rights

patch /api/http/applications/{application}/authorizations/authorized-rights/request-rights

Request rights for an application in specified context

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

contextIdentifier: PermissionContextIdentifier
rightCodes: array of string

Response
No arguments

Get all required rights

get /api/http/applications/{application}/authorizations/required-rights

List required rights for an application

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
array of `RightDTO`

Update required right

patch /api/http/applications/{application}/authorizations/required-rights

Update list of required rights for an application

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

rightCodesToAdd: array of string
rightCodesToRemove: array of string
requestRightsInAuthorizedContexts: boolean

Response
No arguments

Regenerate app secret

post /api/http/applications/{application}/client-secret/regenerate

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
No arguments

Get client secret

get /api/http/applications/{application}/client-secret

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`string`

Create permanent token

post /api/http/applications/{application}/permanent-tokens

Create a permanent token for the given application that can be used to access the current organization

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

name: string
scope: string
expires: string (format: date-time) ( Nullable and Optional , defaults to null)

Response

object with fields:

first: ES_ApplicationPermanentToken
second: string

Get all permanent tokens

get /api/http/applications/{application}/permanent-tokens

Get permanent tokens used to access the current organization by the given application

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of ES_ApplicationPermanentToken

Update permanent token

patch /api/http/applications/{application}/permanent-tokens/{tokenId}

Update an existing personal token used to access the current organization. The permanent token ' s name and/or scope can be updated.

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

tokenId: string (Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)
scope: string ( Nullable and Optional , defaults to null)
expires: string (format: date-time) ( Nullable and Optional )

Response
No arguments

Delete permanent token

delete /api/http/applications/{application}/permanent-tokens/{tokenId}

Delete a personal token used to access the current organization

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

tokenId: string (Path)

Response
No arguments

Delete current permanent token

delete /api/http/applications/{application}/permanent-tokens/current

Delete personal token of the given application

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
No arguments

Regenerate signing key

post /api/http/applications/{application}/signing-key/regenerate

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
No arguments

Get signing key

get /api/http/applications/{application}/signing-key

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`string`

Add ssh key

post /api/http/applications/{application}/ssh-keys

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

publicKey: string
comment: string

Response
No arguments

Get ssh keys

get /api/http/applications/{application}/ssh-keys

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
array of `SshKeyData`

Delete ssh key

delete /api/http/applications/{application}/ssh-keys/{fingerprint}

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

fingerprint: string (Path)

Response
No arguments

Get ui extensions

get /api/http/applications/{application}/ui-extensions

Get UI extensions supported by the application in specified context. Omit contextIdentifier to get UI extensions in all contexts

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

contextIdentifier: string in one of the formats

channel: string
folder: string
document: string
global
profile: ProfileIdentifier
project: ProjectIdentifier
team: TeamIdentifier

(Query)

Response
array of `AppUiExtensionApi`

Disable application ui

patch /api/http/applications/{application}/ui-extensions/disable-for-everybody

Disable application UI for everybody in specified context. Requires Superadmin right for global context, AdminProject for project context, AdminChannel for channel context. Users will still be able to enable application UI individually.

Rights, that may be checked: View applications, Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

contextIdentifier: PermissionContextIdentifier

Response
No arguments

Disable application ui for me

patch /api/http/applications/{application}/ui-extensions/disable-for-me

Disable application UI in specified context for the current user

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

contextIdentifier: PermissionContextIdentifier

Response
No arguments

Enable application ui

patch /api/http/applications/{application}/ui-extensions/enable-for-everybody

Enable application UI for everybody in specified context. Requires Superadmin right for global context, AdminProject for project context, AdminChannel for channel context. Users will still be able to disable application UI individually.

Rights, that may be checked: View applications, Grant permissions to other members, Manage project permission scheme, Manage channels

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

contextIdentifier: PermissionContextIdentifier

Response
No arguments

Enable application ui for me

patch /api/http/applications/{application}/ui-extensions/enable-for-me

Enable application UI in specified context for the current user

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

contextIdentifier: PermissionContextIdentifier

Response
No arguments

Authorize unfurled domains

post /api/http/applications/{application}/unfurl-domains/authorize

Authorize domains for unfurling by the application

Rights, that may be checked: Authorize domains and patterns for app-powered previews

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

domains: array of string
List of domains to approve or reject providing link previews for
approve: boolean
True for approving or false for denying link previews for the provided list of domains

Response
No arguments

Get all unfurl domains

get /api/http/applications/{application}/unfurl-domains

List domains for unfurling by the application

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
array of `ApplicationUnfurlDomain`

Authorize unfurled patterns

post /api/http/applications/{application}/unfurl-patterns/authorize

Authorize patterns for unfurling by the application

Rights, that may be checked: Authorize domains and patterns for app-powered previews

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

patterns: array of string
List of external ID prefixes to approve or reject providing link previews for
approve: boolean
True for approving or false for denying link previews for the provided list of external ID prefixes

Response
No arguments

Get all unfurl patterns

get /api/http/applications/{application}/unfurl-patterns

List patterns for unfurling by the application

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
array of `ApplicationUnfurlPattern`

Regenerate verification token

post /api/http/applications/{application}/verification-token/regenerate

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
No arguments

Get verification token

get /api/http/applications/{application}/verification-token

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

Response
`string`

Create webhook

post /api/http/applications/{application}/webhooks

Create application webhook

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

object with fields:

name: string
description: string ( Nullable and Optional , defaults to null)
endpoint: EndpointCreateDTO ( Nullable and Optional , defaults to null)
endpointAuth: EndpointAuthCreateDTO ( Nullable and Optional , defaults to null)
enabled: boolean ( Optional , defaults to true)
acceptedHttpResponseCodes: array of integer (format: int32)
doRetries: boolean ( Optional , defaults to true)

Response
`WebhookRecord`

Get all webhooks

get /api/http/applications/{application}/webhooks

Get application webhooks

Rights, that may be checked: View applications

Request arguments
`application`: string in one of the formats `clientId`: `string` Specifies application by the client id that it uses to authenticate in Space Read more `id`: `string` Specifies application by the identifier that can be fetched via Get all applications method `me` Specifies application that corresponds to the caller of this API method. Applicable only for calls made by Space applications. (Path)
`withArchived`: `boolean` (Query) ( Optional , defaults to `false`)
`query`: `string` (Query) ( Optional , defaults to `""`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of FullWebhookDTO

Post webhook

post /api/http/applications/{application}/webhooks/{webhookId}

Restore archived application webhook

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
No arguments

Update webhook

patch /api/http/applications/{application}/webhooks/{webhookId}

Update application webhook

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

object with fields:

name: string ( Optional )
description: string ( Nullable and Optional )
enabled: boolean ( Optional )
endpoint: ExternalEndpointUpdateDTO ( Nullable and Optional )
endpointAuth: EndpointAuthUpdateDTO ( Nullable and Optional )
acceptedHttpResponseCodes: array of integer (format: int32) ( Optional )
doRetries: boolean ( Optional )

Response
No arguments

Delete webhook

delete /api/http/applications/{application}/webhooks/{webhookId}

Archive application webhook

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
No arguments

Bearer token webhooks

get /api/http/applications/{application}/webhooks/{webhookId}/bearer-token

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
`string`

Post custom header

post /api/http/applications/{application}/webhooks/{webhookId}/custom-headers

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

object with fields:

headers: array of CustomHttpHeaderDTO

Response
No arguments

Get custom header

get /api/http/applications/{application}/webhooks/{webhookId}/custom-headers

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
array of `CustomHttpHeaderDTO`

Regenerate

post /api/http/applications/{application}/webhooks/{webhookId}/signing-key/regenerate

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
No arguments

Get signing key (webhooks)

get /api/http/applications/{application}/webhooks/{webhookId}/signing-key

Rights, that may be checked: View application secrets

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
`string`

Create subscription

post /api/http/applications/{application}/webhooks/{webhookId}/subscriptions

Add webhook subscription

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

object with fields:

name: string
subscription: CustomGenericSubscriptionIn

Response
`SubscriptionDTO`

Get all subscriptions

get /api/http/applications/{application}/webhooks/{webhookId}/subscriptions

Get webhook subscriptions

Rights, that may be checked: View applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

Response
array of `SubscriptionDTO`

Request missing rights

post /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}/request-missing-rights

Ensures that all permissions required for this subscription are requested in the corresponding permission role

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

subscriptionId: string (Path)

Response
No arguments

Update subscription

patch /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}

Update webhook subscription

Rights, that may be checked: Update applications

Request arguments
`application`: string in one of the formats `clientId`: `string` Specifies application by the client id that it uses to authenticate in Space Read more `id`: `string` Specifies application by the identifier that can be fetched via Get all applications method `me` Specifies application that corresponds to the caller of this API method. Applicable only for calls made by Space applications. (Path)
`webhookId`: `string` (Path)
`subscriptionId`: `string` (Path)
object with fields: `name`: `string` ( Optional ) `enabled`: `boolean` ( Optional ) `subscription`: `CustomGenericSubscriptionIn` ( Optional )

Response
`SubscriptionDTO`

Delete subscription

delete /api/http/applications/{application}/webhooks/{webhookId}/subscriptions/{subscriptionId}

Delete webhook subscription

Rights, that may be checked: Update applications

Request arguments

application: string in one of the formats

clientId: string
Specifies application by the client id that it uses to authenticate in Space
Read more
id: string
Specifies application by the identifier that can be fetched via Get all applications method
me
Specifies application that corresponds to the caller of this API method.
Applicable only for calls made by Space applications.

(Path)

webhookId: string (Path)

subscriptionId: string (Path)

Response
No arguments

Last modified: 28 September 2022