Sign in
Steps

Create step

Changed on

Creates a new step within a guide

post/api/v1/steps

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/steps
  • Auth: none declared

Request body

action'click' | 'input' | 'navigation' | 'keypress'

The browser interaction type captured for the step

action_textstring nullable
guide_idstring uuid required
insert_after_step_idstring nullable
insert_before_step_idstring nullable
notesstring nullable
target_elementobject nullable
type'interaction' | 'canvas' required

The browser interaction type captured for the step

urlstring nullable

Example request

{
  "guide_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
}

Response

Created

Example response

{
  "step": {
    "guide_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "media_assets": [
      {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "step_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      }
    ]
  }
}

Changes

  • a294b480da05Revision changes
    • warning

      added the new keypress enum value to the ///// response property for the response status

    • info

      added the new keypress enum value to the request property