ASasana
Modal forms

On submit callback

Note: The path is a placeholder. The actual path is determined by the configuration of the app component.

The callback request made to an app server when a form is submitted. The request is subject to a 10-second timeout if no response is received from the app server. <br> <br> <a href="https://d3ki9tyy5l5ruj.cloudfront.net/obj/a58c2641ab72105505ea9d63cf27098d79e56c71/ac-form-on-submit.png"> <img src="https://d3ki9tyy5l5ruj.cloudfront.net/obj/a58c2641ab72105505ea9d63cf27098d79e56c71/ac-form-on-submit.png" alt="App components form on submit request flow"/> </a>

post/on_submit_callback_path_placeholder

Request

  • Base URL
    {siteUrl}
  • URL
    {siteUrl}/on_submit_callback_path_placeholder
  • Auth
    none declared

Request body

expires_atstring

The time (in ISO 8601 date format) when the request should expire.

userstring

The user GID this hook is coming from.

workspacestring

The workspace GID this hook is coming from.

valuesobject

An object that maps each FormField’s GID to its value. Refer to the value property on the FormField schema: FormField-Checkbox, FormField-Date, FormField-Datetime, FormField-Dropdown, FormField-MultiLineText, FormField-RadioButton, FormField-RichText, FormField-SingleLineText, FormField-StaticText, FormField-Typeahead

taskstring

The task GID this hook is coming from.

attachmentstring

The GID of the attachment created from the form submission.

Example request

{
  "expires_at": "2019-04-15T01:01:46.055Z",
  "user": "54321",
  "workspace": "12345",
  "values": {
    "checkbox_field_1": [
      "opt-in"
    ],
    "date_field_1": "2021-12-31T08:00:00.000Z",
    "datetime_field_1": "2023-01-01T00:00:00.000Z",
    "dropdown_field_1": "red",
    "multi_line_text_field_1": "Multiline Text",
    "radio_button_field_1": "blue",
    "rich_text_field_1": "<BODY>Rich Text</BODY>",
    "single_line_text_field_1": "Single Line Text",
    "static_text_field_1": "Static Text",
    "typeahead_field_1": {
      "icon_url": "https://example.com/icon.png",
      "subtitle": "Subtitle",
      "title": "Title",
      "value": "Typeahead"
    }
  },
  "task": "67890",
  "attachment": "12345"
}

Response

Successfully attached the resource created by the form.

resource_namestring required

The name of the attached resource

resource_urlstring required

The URL of the attached resource

errorstring

The error that should be displayed to the user

Example response

{
  "resource_name": "Build the Thing",
  "resource_url": "https://example.atlassian.net/browse/CP-1",
  "error": "No resource matched that input"
}

Changes

No recorded changes to this operation across all 1 revision of this API.