• Actions
    • Applications
    • Batch
    • Boards
    • Cards
    • Checklists
    • CustomFields
    • Emoji
    • Enterprises
    • Labels
    • Lists
    • Members
    • Notifications
    • Organizations
    • Plugins
    • Tokens
    • Webhooks
    Cloud
    Trello / Reference / REST API

    Webhooks

    Postman Collection
    OpenAPI
    POST

    Create a Webhook

    Create a new webhook.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Query parameters

    description

    string

    callbackURL

    string

    Required
    idModel

    TrelloID

    Required
    active

    boolean

    Responses

    Success

    application/json

    Webhook
    POST/webhooks/
    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'
    200Response
    1 2 3 4 5 6 7 8 9 { "id": "5abbe4b7ddc1b351ef961414", "description": "Board Webhook", "idModel": "5abbe4b7ddc1b351ef961414", "callbackURL": "https://mywebhookurl.com/?type=board", "active": true, "consecutiveFailures": 0, "firstConsecutiveFailDate": "<string>" }
    GET

    Get a Webhook

    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.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    application/json

    Webhook
    GET/webhooks/{id}
    1 2 3 curl --request GET \ --url 'https://api.trello.com/1/webhooks/{id}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 { "id": "5abbe4b7ddc1b351ef961414", "description": "Board Webhook", "idModel": "5abbe4b7ddc1b351ef961414", "callbackURL": "https://mywebhookurl.com/?type=board", "active": true, "consecutiveFailures": 0, "firstConsecutiveFailDate": "<string>" }
    PUT

    Update a Webhook

    Update a webhook by ID.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    id

    TrelloID

    Required

    Query parameters

    description

    string

    callbackURL

    string

    idModel

    TrelloID

    active

    boolean

    Responses

    Success

    application/json

    Webhook
    PUT/webhooks/{id}
    1 2 3 curl --request PUT \ --url 'https://api.trello.com/1/webhooks/{id}?key=APIKey&token=APIToken' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 { "id": "5abbe4b7ddc1b351ef961414", "description": "Board Webhook", "idModel": "5abbe4b7ddc1b351ef961414", "callbackURL": "https://mywebhookurl.com/?type=board", "active": true, "consecutiveFailures": 0, "firstConsecutiveFailDate": "<string>" }
    DEL

    Delete a Webhook

    Delete a webhook by ID.

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    id

    TrelloID

    Required

    Responses

    Success

    DEL/webhooks/{id}
    1 2 curl --request DELETE \ --url 'https://api.trello.com/1/webhooks/{id}?key=APIKey&token=APIToken'
    GET

    Get a field on a Webhook

    Get a field on a Webhook

    Forge and OAuth2 apps cannot access this REST resource.

    Request

    Path parameters

    id

    TrelloID

    Required
    field

    string

    Required

    Responses

    Success

    GET/webhooks/{id}/{field}
    1 2 curl --request GET \ --url 'https://api.trello.com/1/webhooks/{id}/{field}?key=APIKey&token=APIToken'

    Rate this page: