Skip to main content

How to announce tasks by API?

Caroline Veiders
Updated
InfoHere you will learn how to announce tasks using the public Urbantz API

Overview:

  1. Requirements
  2. Announce tasks by API

1. Requirements

  1. Consult our detailed API documentation: https://docs.urbantz.com/
  2. Download and install the API platform of your choice. We recommend Postman.
  3. You will need the following information:
    • The API key of your platform: Find it in Administration > Platform > General
    • The secret API key of your flow. You can find in Administration > Flows > Integration > Announcement and click the plus button. 

2. Announce tasks by API

  1. Open Postman or another API environment and select the method POST
  2. Insert this URL: https://api.urbantz.com/v2/task/
  3. Insert the following headers:
    • Content-type: application/json
    • x-api-key:  [API key of the platform]
    • x-api-secret:  [API key of the Flow] 
      Alternatively, you can use Basic Auth and enter the credentials.
  4. Insert your request payload in the body
  5. Click SEND

Urbantz will return a status code, a timestamp and an announcement Id and an announcement line will be created on the Announcement page of your platform. 

Related articles