The Trello REST API

Create a Webhook

POST /1/webhooks/

Create a new webhook.

Request

Query parameters

key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$

token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

description

string

A string with a length from 0 to 16384.

Min length: 0, Max length: 16384

callbackURL Required

string

A valid URL that is reachable with a HEAD and POST request.

Format: url

idModel Required

string

ID of the model to be monitored

Pattern: ^[0-9a-fA-F]{24}$

active

boolean

Determines whether the webhook is active and sending POST requests.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.trello.com/1/webhooks/?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&callbackURL={callbackURL}&idModel=5abbe4b7ddc1b351ef961414' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Webhook

Get a Webhook

GET /1/webhooks/{id}

Get a webhook by ID.

Request

Path parameters

id Required

string

ID of the webhook to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Query parameters

key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$

token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.trello.com/1/webhooks/{id}' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Webhook

Update a Webhook

PUT /1/webhooks/{id}

Update a webhook by ID.

Request

Path parameters

id Required

string

ID of the webhook to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Query parameters

key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$

token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

description

string

A string with a length from 0 to 16384.

Min length: 0, Max length: 16384

callbackURL

string

A valid URL that is reachable with a HEAD and POST request.

Format: url

idModel

string

ID of the model to be monitored

Pattern: ^[0-9a-fA-F]{24}$

active

boolean

Determines whether the webhook is active and sending POST requests.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.trello.com/1/webhooks/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

200

Success

Content type	Value
application/json	Webhook

Delete a Webhook

DELETE /1/webhooks/{id}

Delete a webhook by ID.

Request

Path parameters

id Required

string

ID of the webhook to retrieve.

Pattern: ^[0-9a-fA-F]{24}$

Query parameters

key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$

token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.trello.com/1/webhooks/{id}'

Responses

200

Success

A schema has not been defined for this response code.

Get a field on a Webhook

GET /1/webhooks/{id}/{field}

Get a field on a Webhook

Request

Path parameters

id Required

string

ID of the webhook.

Pattern: ^[0-9a-fA-F]{24}$

field Required

string

Field to retrieve. One of: active, callbackURL, description, idModel

Valid values: active, callbackURL, description, idModel, consecutiveFailures, firstConsecutiveFailDate

Query parameters

key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$

token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'https://api.trello.com/1/webhooks/{id}/{field}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

200

Success

A schema has not been defined for this response code.