Rate this page:
POST /1/webhooks/
Create a new webhook.
string
A string with a length from 0 to 16384.
0, Max length: 16384string
A valid URL that is reachable with a HEAD and POST request.
urlstring
ID of the model to be monitored
^[0-9a-fA-F]{24}$boolean
Determines whether the webhook is active and sending POST requests.
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/webhooks/?callbackURL={callbackURL}&idModel=5abbe4b7ddc1b351ef961414&key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json |
GET /1/webhooks/{id}
Get a webhook by ID. You must use the token query parameter and pass in the token the webhook was created under, or else you will encounter a 'webhook does not belong to token' error.
string
ID of the webhook to retrieve.
^[0-9a-fA-F]{24}$1 2 3
curl --request GET \
--url 'https://api.trello.com/1/webhooks/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json |
PUT /1/webhooks/{id}
Update a webhook by ID.
string
ID of the webhook to retrieve.
^[0-9a-fA-F]{24}$string
A string with a length from 0 to 16384.
0, Max length: 16384string
A valid URL that is reachable with a HEAD and POST request.
urlstring
ID of the model to be monitored
^[0-9a-fA-F]{24}$boolean
Determines whether the webhook is active and sending POST requests.
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/webhooks/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'Success
| Content type | Value |
|---|---|
| application/json |
DELETE /1/webhooks/{id}
Delete a webhook by ID.
string
ID of the webhook to retrieve.
^[0-9a-fA-F]{24}$1 2
curl --request DELETE \
--url 'https://api.trello.com/1/webhooks/{id}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
GET /1/webhooks/{id}/{field}
Get a field on a Webhook
string
ID of the webhook.
^[0-9a-fA-F]{24}$string
Field to retrieve. One of: active, callbackURL, description, idModel
Valid values: active, callbackURL, description, idModel, consecutiveFailures, firstConsecutiveFailDate
1 2
curl --request GET \
--url 'https://api.trello.com/1/webhooks/{id}/{field}?key=APIKey&token=APIToken'Success
A schema has not been defined for this response code.
Rate this page: