Skip to main content

Add a Block

This custom action enables makers to add a block to an existing page in their Notion data source.

For additional details regarding the Notion API reference for this action, see Append block children in the Notion developer documentation.

Configure the Request

  1. In Tonkean, navigate to your Notion data source and select Actions in the data source configuration panel. The Actions screen displays.

    actions_select.png
  2. Select Create New Custom Action in the upper right. The New HTTP Custom Action window displays.

    create_new_custom_action_select.png
  3. In the The action will be field, select the first dropdown and select Updating, then select the second dropdown and select Page. When finished, select Create. The window closes and the Custom Action General screen displays.

    action_will_be_updating_page.png
  4. Enter a unique Display Name for the action. This is the title of the action that displays to other makers.

    add_block_rename_custom_action.png
  5. In the Settings panel, select Request. The Request screen displays.

    add_block_request_select.png
  6. In the Path field, select the method dropdown and select PATCH, then enter the endpoint URL: v1/blocks/[page_id]/children

    add_block_request_path.png
  7. Create an action param for the page ID. Enter "Page ID" in the available field in the Actions Params section, then select + Add Param.

    add_block_add_page_id_param.png
  8. Replace the placeholder [page_id] value in the endpoint with the newly-created action param. Remove [page_id] in the endpoint, then select the insert field button, insert_field.png, and choose the Page ID field.

    add_block_request_insert_path_id_param.png

    The complete endpoint path should display as follows:

    add_block_path_complete.png
  9. In the Body field, enter the request body with any blocks you want to add. In the JSON below, a heading and paragraph block are added.

    {
        "children": [
            {
                "object": "block",
                "type": "heading_2",
                "heading_2": {
                    "rich_text": [
                        {
                            "type": "text",
                            "text": {
                                "content": ""
                            }
                        }
                    ]
                }
            },
            {
                "object": "block",
                "type": "paragraph",
                "paragraph": {
                    "rich_text": [
                        {
                            "type": "text",
                            "text": {
                                "content": ""
                            }
                        }
                    ]
                }
            }
        ]
     }
    

    For each required dynamic value, create a new param and include it in the body. For this example of the action, Heading and Paragraph are both dynamic values you must create params for. Additional block types require additional params.

    To create a param, follow the steps below:

    1. In the Actions Params section, enter a param name in the available field, then select + Add Param.

      add_page_request_add_param.png
    2. Repeat step #1 for each param you want to create.

    3. For each value where you must include a param, place your cursor between the quotes, then select the insert field button, insert_field.png and choose the action param to insert.

    When finished, the Body field should appear as in the image below, with the appropriate params included:

    add_block_request_body_complete.png
  10. In the Headers section, select + Add Header. A new Header Name and Header Value fields display.

    add_page_add_header_select.png
  11. Enter the following values:

    • Header Name - Notion-Version

    • Header Value - 2022-06-28

    add_page_add_header_values.png

The request is complete and ready for testing.

Test the Request

  1. Select Test Request. The Test Action window displays.

    add_block_test_request_select.png
  2. Enter values for each action param:

    • Page ID - {Your page ID}

      If you're using Notion in a web browser, you can locate the 32-character page ID in the URL. When on the relevant page you want to add a block to, the ID is located after the page title.

      notion_page_id_url.png

      If you're using the Notion desktop app, select Share, copy and paste the URL into a web browser, then extract the page ID from the URL.

    • Heading - The new heading to add to the block.

    • Paragraph - The new paragraph to add to the block.

    add_block_test_action_params.png
  3. Select Run Test. The request runs with the param values you provided and the Response section populates, including a notification with the HTTP response code. The Response Body and Headers tabs in the Response section display the response from the endpoint.

    add_block_test_run_test.png

    If the test is successful, a 200 Success response code displays.

    add_page_test_success.png

    If you don't receive the expected response, or your test request fails, close the Test Action window and return to the Request screen to troubleshoot the problem.

    Some common errors with Notion custom actions are caused by a particular entity not being shared with Tonkean. In Notion, navigate to the relevant entity (in this case, a page) and select Share in the upper right. Ensure the Tonkean integration has edit permissions.

  4. If the test is successful and you receive the response you expect, close the Test Action window and select Save Action Changes in the upper right of the Request screen.

The Add a Block custom action is complete and ready to use in a module.