External HTTP Requests

When creating an automation, External HTTP Requests are used to complete actions that are not already built in Kizen.

 

External HTTP Requests can also be used to send data to other systems with open APIs.

 

External HTTP Overview

To perform an action, you must first select one of the four Custom HTTP Actions there are to choose from.

  • Put: Used to change an entire record
  • Post: Used to create a record
  • Patch: Used to partially update a record
  • Delete: Used to delete a record

Example: A Patch request is used to update which stage an opportunity is in within a specified pipeline. 

 

The Request URL is telling the API where you want the change to happen. The Request URL can be found in:

Kizen's Base URL will always be https://app.go.kizen.com/api. You will then need to add additional details such as the type of object being updated, the object id, what is being updated in that object, and the record id.

The Developer Tools are a toolkit built into your web browser that allows you to see the API calls that are occurring between a website and a database and gather data. We will use the Network tab for HTTP Requests. 

 

To open Developer Tools in Google Chrome:

  1. Click View in the browser menu
  2. Scroll down to the Developer menu
  3. Click Developer Tools
  4. Select Network at the top menu bar 
  5. On the Headers tab, find the correct request (Hint: Put, Post, Patch, Delete)
  6. Once you've found the correct request, switch to the Payload tab
  7. Select View Source
  8. Copy the payload value and paste into Data Payload in the Edit Action section

Within Developer Tools you can find the Data Payload. This is the action that is being requested within Kizen. 

  • Example: {"stage_id":"bd6dc78d-368c-4a59-8a0a-9d92b42d0b26","record_ids":["eab61153-b43d-4040-843d-53c9580b6f5d"],"index":0}

Headers are used to authenticate the data changes you are requesting through an API Key, User ID, Business ID, and application type. The Header Values can be found in your Profile Information.

  • API Key is the verification
    • You will only need to create this once.
  • User ID identifies who on the account is requesting the change
  • Business ID identifies the account requesting the change
  • Content Type is the data format type
    • Ex: application/json

 

To create a HTTP Request:

  1. Add an Action step mceclip0.png
  2. Select External HTTP Requests as the actionmceclip1.png
  3. Select the Custom HTTP Action mceclip2.png
  4. 4. Enter the Request URL (Hint: Kizen's Base URL is https://app.go.kizen.com/api) mceclip6.png
  5. Find the Data Payload (be sure to use the source view) mceclip7.png
  6. Under Customize Header (Parameters and Values), click Add Parameter mceclip8.png
  7. Enter Parameter "x-api-key" mceclip9.png
  8. Click Add Parameter mceclip15.png
  9. Enter "x-business-id"mceclip16.png
  10. Click Add Parameter mceclip1.png
  11. Enter "x-user-id" mceclip18.png
  12. Click Add Parameter mceclip19.png
  13. Enter "content-type" mceclip20.png
  14. In a new tab, open Kizen
  15. Click the dropdown next to your profile iconmceclip23.png
  16. Select My Profile mceclip22.png
  17. If you have previously generated an API key, click the 3 dots under the Actions columnmceclip24.png
  18. Select View API Key mceclip25.png
  19. If you have not previously generated an API Key, click + Add API Key mceclip26.png
  20. Copy the API Key, Business ID, and User ID into the corresponding parameter value mceclip28.png
  21. Enter application/json for "content-type" mceclip2.png
  22. Click Savemceclip30.png
Was this article helpful?
0 out of 0 found this helpful