SDK Apps > Webhooks

List App Webhooks

get
/sdk/apps/{SDK_appName}/webhooks
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
Responses
chevron-right
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/webhooks
200

Successful response

Create Webhook

post
/sdk/apps/{SDK_appName}/webhooks
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
Header parameters
Content-TypestringOptionalExample: application/json
Body
typestringOptional
labelstringOptional
connectionstringOptional
Responses
chevron-right
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/webhooks
200

Successful response

Get Webhook

get
/sdk/apps/webhooks/{SDK_webhookName}
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_webhookNamestringRequired
Responses
chevron-right
200

Successful response

application/json
get
/sdk/apps/webhooks/{SDK_webhookName}
200

Successful response

Delete Webhook

delete
/sdk/apps/webhooks/{SDK_webhookName}
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_webhookNamestringRequired
Responses
chevron-right
200

Successful response

application/json
delete
/sdk/apps/webhooks/{SDK_webhookName}
200

Successful response

Update Webhook

patch
/sdk/apps/webhooks/{SDK_webhookName}
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_webhookNamestringRequired
Header parameters
Content-TypestringOptionalExample: application/json
Body
labelstringOptional
connectionstring | nullableOptional
altConnectionstring | nullableOptional
Responses
chevron-right
200

Successful response

application/json
patch
/sdk/apps/webhooks/{SDK_webhookName}
200

Successful response

Get Webhook Section

get
/sdk/apps/webhooks/{SDK_webhookName}/{SDK_webhookSection}
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_webhookNamestringRequired
SDK_webhookSectionstring · enumRequiredPossible values:
Responses
chevron-right
200

Successful response

application/json
get
/sdk/apps/webhooks/{SDK_webhookName}/{SDK_webhookSection}
200

Successful response

Set Webhook Section

put
/sdk/apps/webhooks/{SDK_webhookName}/{SDK_webhookSection}
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_webhookNamestringRequired
SDK_webhookSectionstring · enumRequiredPossible values:
Header parameters
Content-TypestringOptionalExample: application/jsonc
Body
outputstringOptional
testbooleanOptional
Responses
chevron-right
200

Successful response

application/json
put
/sdk/apps/webhooks/{SDK_webhookName}/{SDK_webhookSection}
200

Successful response

Last updated