Trello Pipe
This article is still being written, please check back soon.
The REST API client provides methods to make it easier to interact with Trello's REST API from a Power-Up. The client primarily helps with authorization; it makes it easy to get a user's OAuth token when you provide your API key.
To get started, you will need to obtain your Trello API key an d Token.
- You can do so by logging into Trello and visiting https://trello.com/app-key.
Global Parameters
There are Global Parameters in this pipe.
API Calls
All the API Calls in this Pipe can be customized, but we've added several to help you get started and expedite the time needed to get you up and running with some of the basic uses.
Board
- Create a Board
- Update a Board
- Create a List a Board
- Create a Label on Board
- Invite a Member to Board via E-mail
- Add Member to Board
- Remove Member to Board
- Delete a Board
- Get all Board
- Get a Board Member
Create a Board
Allows to create a new board.
URL
First you can pass a URL and Method in the overview tab for create a new board. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/boards/?key={key}&token={token}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {name} is assign parameter that is created in parameters tab.
Parameters
Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.
- name - Set unique Board Name ( Required ).
Note: name parameter is set in query parameter ( see above screen shot).
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Url
- Description
Update a Board
Allows to update an existing board by id.
URL
First you can pass a URL and Method in the overview tab for update a board. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/boards/{id}?key={key}&token={token}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of board ( Required ).
- name - The new name for the board ( Required ).
Note: id, name parameter is set in query parameter ( see above screen shot).
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Url
- Description
Create a List Board
Allows to create a list on a board.
URL
First you can pass a URL and Method in the overview tab for create a list in board. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/boards/{id}/lists?key={key}&token={token}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- name - The new name for the list ( Required ).
- id - Unique id of board ( Required ).
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Url
- Description
Create a Label Board
Allows to create a Label on a board.
URL
First you can pass a URL and Method in the overview tab for create a label in board. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/boards/{id}/labels?key={key}&token={token}&name={name}&color={color}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name}, {color} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- name - The new name for the list ( Required ).
- id - Unique id of board ( Required ).
- color - Sets the color of the new label. Valid values are a label color or
null
( Required ).
Note: id, name and color parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Board id
- Name
- Color
Invite Member to Board Via E-mail
Allows to Invite a Member to a Board via their email address.
URL
First you can pass a URL and Method in the overview tab for invite a member to board. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/boards/{id}/members?key={key}&token={token}&email={email}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {email} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- email - Unique email id ( Required ).
- id - Unique id of board ( Required ).
Note: id and email parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Board id
Note: Here only set Board id as response because of invited members is more then one.
Add Member to Board
Allows to Add a member to the board.
URL
First you can pass a URL and Method in the overview tab for add member to board. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/boards/{id}/members/{idMember}?key={key}&token={token}&type={type}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {idMember} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- idMember - Unique id of member ( Required ).
- id - Unique id of board ( Required ).
Note: id and idMember parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Note: Member id get from the "Invite Member to Board Via E-mail" pipe response.
Response
Built in responses already added are below.
- Board id
Note: Here only set Board id as response because of add members is more then one.
Remove Member to Board
Allows to remove a member to the board.
URL
First you can pass a URL and Method in the overview tab for remove member to board. The required URL and method that must be included below :
- Method :DELETE
- Request URL : https://api.trello.com/1/boards/{id}/members/{idMember}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {idMember} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- idMember - Unique id of member ( Required ).
- id - Unique id of board ( Required ).
Note: id and idMember parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Note: Member id get from the "Get a Board Member" pipe response.
Response
Built in responses already added are below.
- Board Id
- Name
- Url
- Description
Delete a Board
Allows to delete a board by id .
URL
First you can pass a URL and Method in the overview tab for remove board. The required URL and method that must be included below :
- Method :DELETE
- Request URL : https://api.trello.com/1/boards/{id}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of board ( Required ).
Note: id parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status and return empty response.
Response
Response is not set because of return empty object with 200
status.
Get all Board
Allows to retrieve all board .
URL
First you can pass a URL and Method in the overview tab for list all board. The required URL and method that must be included below :
- Method :GET
- Request URL : https://api.trello.com/1/members/me/boards?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status and return empty response.
Response
Note: Here response is not set because of board is more then one.
Get Member of Board
Allows to retrieve all member of board.
URL
First you can pass a URL and Method in the overview tab for list all board member. The required URL and method that must be included below :
- Method :GET
- Request URL : https://api.trello.com/1/boards/{id}/members?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Note: Here response is not set because of member of board is more then one.
List
- Create a List
- Update a Field on a List
- Archive all Card in List
- Move List to board
- Move all Card in List
Create a List
Allows to create a list in board.
Note : "Create a List" api call is already created as "Create a List Board" api call.
Update a Field on List
Allows to Update a existing list by id. Allow to change name
, pos
, subscribed
field.
URL
First you can pass a URL and Method in the overview tab for update existing list on board. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/lists/{id}/{field}?key={key}&token={token}&value={value}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {field}, {value} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- field - The field on the List to be updated valid values:
name
,pos
,subscribed
( Required ). - value - The new value for the field ( Required ).
- id - Unique id of List ( Required ).
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Closed
- Board id
Archive a Field on List
Allows to archive all cards in a list
URL
First you can pass a URL and Method in the overview tab for archive all card in list. The required URL and method that must be included below :
- Method :POST
- Request URL : https://api.trello.com/1/lists/{id}/archiveAllCards?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of List ( Required ).
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status. return an empty response.
Response
Response is not set because of return response is empty.
Move list to Board
Allows to move list to board.
URL
First you can pass a URL and Method in the overview tab for move list to board. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/lists/{id}/idBoard?key={key}&token={token}&value={value}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of List ( Required ).
- value - The ID of the board to move the list to.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Closed
- Board id
Card
- Create a Card
- Update a Card
- Create a attachment on Card
- Delete a attachment on Card
- Create a Checklist on Card
- Add Member to Card
- Remove Member to Card
- Create a Label on a Card
- Remove a Label on a Card
- Delete a Card
Create a Card
Allows to create a card on list.
URL
First you can pass a URL and Method in the overview tab for create a card on list. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/cards?key={key}&token={token}&idList={idList}&name={name}&desc={desc}&due={due}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {idList}, {name}, {desc}, {due} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- name - The new name for the card ( Required ).
- idList - Unique id of list ( Required ).
- desc - The description of card.
- due - The due date of card, allow date format DD/MM/YYYY.
Note: idList, name, desc and due parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Board id
- List id
- Card name
- Url
- Description
- Due Date
Update a Card
Allows to update a existing card by id on list.
URL
First you can pass a URL and Method in the overview tab for update a card on list. The required URL and method that must be included below :
- Method : PUT
- Request URL : https://api.trello.com/1/cards/{id}?key={key}&token={token}&name={name}&due={due}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name}, {due} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- name - The new name for the card ( Required ).
- id - Unique id of card ( Required ).
- due - The due date of card, allow date format DD/MM/YYYY.
Note: id, name and due parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Board id
- List id
- Card name
- Url
- Description
- Due Date
Create a Attachment on card
Allows to create a attachment to card by id on list.
URL
First you can pass a URL and Method in the overview tab for create attachment to card on list. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/cards/{id}/attachments?key={key}&token={token}&url={url}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {url}, {name} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- name - The new name for the attachment.
- id - Unique id of card ( Required ).
- url - The url of attachment ( Required ).
Note: id, name and url parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Date
- Attachment URL
- Attachment name
- File Name
Delete a Attachment on Card
Allows to delete a attachment to card by id on list.
URL
First you can pass a URL and Method in the overview tab for remove attachment to card on list. The required URL and method that must be included below :
- Method : DELETE
- Request URL : https://api.trello.com/1/cards/{id}/attachments/{idAttachment}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {idAttachment}, {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- idAttachment - Unique id of attachment.
- id - Unique id of card ( Required ).
Note: id and idAttachment parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status. Return empty response.
Response
Response is not set because of return response is empty.
Create a Checklist on Card.
Allows to create a checklist to card by id.
URL
First you can pass a URL and Method in the overview tab for create checklist to card. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/cards/{id}/checklists?key={key}&token={token}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- name - The new name for checklist ( Required ).
- id - Unique id of card ( Required ).
Note: id and name parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Card id
- Board id
Add Member on Card.
Allows to add member on card.
URL
First you can pass a URL and Method in the overview tab for add member on card. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/cards/{id}/idMembers?key={key}&token={token}&value={value}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {value} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- value - Unique id of member ( Required ).
- id - Unique id of card ( Required ).
Note: id and value parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Here response is not set because of add member is more then one.
Remove Member on Card.
Allows to remove member on card.
URL
First you can pass a URL and Method in the overview tab for remove member on card. The required URL and method that must be included below :
- Method :DELETE
- Request URL : https://api.trello.com/1/cards/{id}/idMembers/{idMember}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- idMember - Unique id of member ( Required ).
- id - Unique id of card ( Required ).
Note: id and idMember parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status. Return an empty response.
Response
Here response is not set because of return empty response.
Add Label to a Card
Allows to add a label on card.
URL
First you can pass a URL and Method in the overview tab for add a label on card. The required URL and method that must be included below :
- Method : POST
- Request URL : https://api.trello.com/1/cards/{id}/idLabels?key={key}&token={token}&value={value}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {value} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of card ( Required ).
- value - The ID of the label to add ( Required ).
Note: id and value parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Board id
- Name
- Color
Remove Label to a Card
Allows to remove a label on card.
URL
First you can pass a URL and Method in the overview tab for remove a label on card. The required URL and method that must be included below :
- Method :DELETE
- Request URL : https://api.trello.com/1/cards/{id}/idLabels/{idLabel}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {idLabel}, {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of card ( Required ).
- idLabel - The ID of the label ( Required ).
Note: id and idLabel parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Response is not set because of return response is empty.
Delete a Card
Allows to remove a card.
URL
First you can pass a URL and Method in the overview tab for remove a card. The required URL and method that must be included below :
- Method :DELETE
- Request URL : https://api.trello.com/1/cards/{id}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of card ( Required ).
Note: id parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Response is not set because of return response is empty.
Checklist
- Update a Checklist
- Create a Check-item on Checklist
- Delete a Check-item on Checklist
- Update Field on a Checklist
- Update a Check-item on Card
- Delete a Checklist
Update a Checklist
Allows to update a existing checklist by id.
URL
First you can pass a URL and Method in the overview tab for update a existing checklist. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/checklists/{id}?key={key}&token={token}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of checklist ( Required ).
- name - The name of checklist ( Required ).
Note: id and name parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Card id
- Board id
Create a Check-item on Checklist
Allows to create a check-item on checklist.
URL
First you can pass a URL and Method in the overview tab for update a existing checklist. The required URL and method that must be included below :
- Method :POST
- Request URL : https://api.trello.com/1/checklists/{id}/checkItems?key={key}&token={token}&name={name}&checked={checked}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {name}, {checked} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of checklist ( Required ).
- name - The name of checkitem ( Required ).
- checked - Determines whether the check item is already checked when created.
Note: id, checked and name parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Checklist id
- State
- Id
- Name
- Due Date
Delete a Check-item on Checklist
Allows to delete a check-item on checklist.
URL
First you can pass a URL and Method in the overview tab for remove a existing checklist. The required URL and method that must be included below :
- Method :DELETE
- Request URL : https://api.trello.com/1/checklists/{id}/checkItems/{idCheckItem}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {idCheckItem} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of checklist ( Required ).
- idCheckItem - Unique id of checkitem ( Required ).
Note: id and idCheckItem parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Response is not set because of return response is empty.
Update a Field on Checklist
Allows to update a field on existing checklist by id.
URL
First you can pass a URL and Method in the overview tab for update a field on existing checklist. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/checklists/{id}/{field}?key={key}&token={token}&value={value}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {field}, {value} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of checklist ( Required ).
- field - Field to update Valid values:
name
,pos
( Required ). - value - The value to change the checklist name to. Should be a string of length 1 to 16384.
Note: id, field and value parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Card id
- Board id
Update a Check-item on Card
Allows to update a existing check-item.
URL
First you can pass a URL and Method in the overview tab for update a existing check-item. The required URL and method that must be included below :
- Method :PUT
- Request URL : https://api.trello.com/1/cards/{id}/checkItem/{idCheckItem}?key={key}&token={token}&name={name}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {idCheckItem}, {name} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of checklist ( Required ).
- idCheckItem - Unique id of check-item ( Required ).
- name - The name of checkitem.
Note: id, idCheckItem and name parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Checklist id
- Id
- Name
- State
- Due date
Delete a Checklist
Allows to delete a checklist by id.
URL
First you can pass a URL and Method in the overview tab for removing a checklist. The required URL and method that must be included below :
- Method : DELETE
- Request URL : https://api.trello.com/1/checklists/{id}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameters tab.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of checklist ( Required ).
Note: id parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Response is not set because of return response is empty.
Webhook
- Create a Webhook
- Get a Webhook
- Update a Webhook
- Delete a Webhook
Create a Webhook
Allows to create a Webhook
URL
First you can pass a URL and Method in the overview tab for create a webhook. The required URL and method that must be included below :
- Method :POST
- Request URL : https://trello.com/1/tokens/{token}/webhooks/?key={key}
Note: Here {key} and {token} is assign parameter that is created in global parameter.
Parameters
Set Parameters must be included in parameters tab.
- description - Description of webhook ( Required ).
- callbackURL - URL for call back URL ( Required ).
- idModel - This can be a id of card, list, board etc ( Required ).
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create a webhook. Here {description}, {callbackURL} and {idModel} is assigned parameters that created in parameters tab.
Note: Here request type use as Raw data.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Webhook id
- Description
- Model id
- Callback URL
- Active
Get a Webhook
Allows to get a single webhook.
URL
First you can pass a URL and Method in the overview tab for get a webhook. The required URL and method that must be included below :
- Method :GET
- Request URL : https://api.trello.com/1/webhooks/{id}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameter.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of webhook ( Required ).
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Webhook id
- Description
- Model id
- Callback URL
- Active
Update a Webhook
Allows to update a existing webhook by id.
URL
First you can pass a URL and Method in the overview tab for update a webhook. The required URL and method that must be included below :
- Method : PUT
- Request URL : https://api.trello.com/1/webhooks/{id}?key={key}&token={token}&callbackURL={callbackURL}&idModel={idModel}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {callbackURL}, {idModel} is assign parameter that is created in parameter.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of webhook ( Required ).
- callbackURL - URL for call back URL ( Required ).
- idModel - This can be a id of card, list, board etc ( Required ).
Note: id, callbackURL and idModel parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Webhook id
- Description
- Model id
- Callback URL
- Active
- Consecutive Failures
- First Consecutive Fail Date
Delete a Webhook
Allows to delete a webhook.
URL
First you can pass a URL and Method in the overview tab for delete a webhook. The required URL and method that must be included below :
- Method : DELETE
- Request URL : https://api.trello.com/1/webhooks/{id}?key={key}&token={token}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id} is assign parameter that is created in parameter.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of webhook ( Required ).
Note: id parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status. Return an empty response.
Response
Response is not set because of return response.
Actions
- Get the Board for Action
- Get the List for Action
- Get the Card for Action
- Get the Member for Action
- Delete an Action
- Create a Reaction for Action
- Delete a Reaction for Action
Get the Board for Action
Allows to get the board for action.
Note:
Trello actions are basic action associated almost with all Trello entities. Trello action could be for example createBoard
which provides you information that create a board, this action is generated immediately when you create board.
Action is defined as:
id - Action id.
idMemberCreator
data
type
date
If you want get all actions of specific card you are able to use GET /1/boards/{boardId}/actions?key={key}&token={token}
. The relationship between Action and another Trello entity is N to one - Trello entity could have N actions but specific action (is defined by ID!) is associated only with one entity.
URL
First you can pass a URL and Method in the overview tab for getting a board for action. The required URL and method that must be included below :
- Method : GET
- Request URL : https://api.trello.com/1/actions/{id}/board?key={key}&token={token}&fields={fields}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {fields} is assign parameter that is created in parameter.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of actions ( Required ).
- fields -
all
or a comma-separated list of board fields Valid values:id
,name
,desc
,descData
,closed
,idMemberCreator
,idOrganization
,pinned
,url
,shortUrl
,prefs
,labelNames
,starred
,limits
,memberships
,enterpriseOwned
( Required ).
.Note: id and fields parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status.
Response
Built in responses already added are below.
- Id
- Name
- Desc
- Desc Data
- Closed
- Id Member Creator
- Pinned
- Url
- Short Url
- Starred
- Enterprise Owned
Note : here built in response is more than two because of enter all
in fields parameter, if you enter all
in fields parameter return full description of board.
Get the List for Action
Allows to get the list for action.
Note:
Trello actions are basic action associated almost with all Trello entities. Trello action could be for example createList
which provides you information that create a List, this action is generated immediately when you create list.
Action is defined as:
id - Action id.
idMemberCreator
data
type
date
If you want get all actions of specific card you are able to use GET /1/lists/{id}/actions?key={key}&token={token}
. The relationship between Action and another Trello entity is N to one - Trello entity could have N actions but specific action (is defined by ID!) is associated only with one entity.
URL
First you can pass a URL and Method in the overview tab for getting a list for action. The required URL and method that must be included below :
- Method : GET
- Request URL : https://api.trello.com/1/actions/{id}/list?key={key}&token={token}&fields={fields}
Note: Here {key} and {token} is assign parameter that is created in global parameter and {id}, {fields} is assign parameter that is created in parameter.
Parameters
Set Parameters must be included in parameters tab.
- id - Unique id of actions ( Required ).
- fields -
all
or a comma-separated list of board fields Valid values:id
,name
,desc
,descData
,closed
,pos
,softLimit
,creationMethod
,idBoard
( Required ).
.Note: id and fields parameter is set in query parameter.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200
status. Return an empty response.
Response
Built in responses already added are below.
- List Id
- Name
- Closed
- Pos
- Soft Limit
- Creation Method
- Board id