POST

/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}

http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

Access Token Required: API Key

Path Parameters

workbookIdstringrequired

The ID of the workbook that contains the screen automation.

appIdstringrequired

The ID of the app that contains the screen automation.

screenIdstringrequired

The ID of the screen that contains the screen automation.

automationIdstringrequired

The ID of the automation action to be performed.

Body Params

rowIdstring

The row ID for the automation if the automation is defined inside a block with source or list.

variablesobject

Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.

clientRequestTokenstring

<p> The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again. </p> <p> Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days. </p>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://honeycode.{region}.amazonaws.com/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'