Within Teamwork, you can
create automations to
send HTTP requests to a
specified URL whenever a
trigger
occurs.
Hypertext
Transfer Protocol (HTTP)
allows you to initiate
communication
and create
highly customizable
integrations with both
internal and external domains.
For example, you could have a
message posted in Teamwork
Chat each time a task is
created in
Teamwork.
Automations are
available at project level via
the List or Table section
of each
project.
Note: Automations can only be viewed, created, and managed by administrators and standard users in the owner company.
Click the Automate button in the top right to open the Automations modal.
Click the Custom Automation button in the top left of the modal to start from scratch.
In
the When section
of
the custom automation
creation view,
you can select any
trigger action
that you would like to use for
your workflow, such as when a
task is added or a task's due
date
changes.
In the Then section,
select Send HTTP request from the Action dropdown menu.
Additional settings for HTTP request
automations:
- URL - the the
http/https address that
the request should
target when
the trigger is executed.
- HTTP method - specify the relevant request
type:
- GET - request
data from a specified
resource.
- POST - send
data to a server to
create/update a
resource.
- PUT - send
data to a server to
create/update a
resource.
- PATCH - apply
partial modifications
to a
resource.
- DELETE - deletes
the specified
resource.
- Payload - specify
the contents to be
sent with the HTTP
request.
- Fully
customized request
body formatted as
JSON.
- Note: Payloads
are only available
with POST/PUT/PATCH
requests.
- Field mapping - select one or multiple
supported field variables to be inserted
into the Payload contents, allowing you to
map specific data from Teamwork.
Teamwork Chat
example
Using automations, you can create a
HTTP request to post information to Teamwork
Chat when a specific action occurs in
Teamwork.
To do this, a Teamwork Chat
administrator will need to set up an incoming
webhook in Teamwork Chat and copy
the generated URL to the URL field of
the automation setup view.
You will need to set up your Payload content using the
supported format which can be found in the Teamwork API
documentation.
You can also click any of the
supported fields at the bottom of the Payload section to include the
corresponding property data in the message to
be posted to Teamwork Chat.
Markdown syntax is supported in the Payload field, allowing you to format the appearance of the message text.
- Embedded link markdown syntax:
- Use
[text to display](url)to embed and format the associated task URL in the payload message. - Syntax example: [
Task namemapped field](Task linkmapped field) - Payload example:
Once you have filled out the relevant HTTP request information, click the Create button at the bottom of the automation modal to complete your
automation.
The automation will then be listed
in the Manage Automations tab of the Automations modal where
you can edit, delete, or toggle
activation.
Each time a new task is added to any
of the projects referenced in the automation,
a message will be posted in the specified
Teamwork Chat channel along with the payload
contents.
For more information, see: Creating Custom
Automations