Webhooks

• List webhooks
• Get webhook
• Create webhook
• Delete webhook

List webhooks

List webhooks on a site.

GET /api/site/{id}/webhooks

Example request :

curl "https://cloud.boxydev.com/api/site/1/webhooks" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "url": "https://123456.x.pipedream.net",
            "created_at": "2022-09-26T20:08:27.000000Z"
        }
    ],
    "links": {
        "first": "https://cloud.boxydev.com/api/site/1/webhooks?page=1",
        "last": "https://cloud.boxydev.com/api/site/1/webhooks?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://cloud.boxydev.com/api/site/1/webhooks",
        "per_page": 20,
        "to": 1,
        "total": 1
    }
}

Get webhook

Show a webhook.

GET /api/site-webhook/{id}

Example request :

curl "https://cloud.boxydev.com/api/site-webhook/1" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json"

Example response :

{
    "id": 1,
    "url": "https://123456.x.pipedream.net",
    "created_at": "2022-09-26T20:08:27.000000Z"
}

Create webhook

Create a webhook.

POST /api/site/{id}/webhook

Parameters :

Example request :

curl "https://cloud.boxydev.com/api/site/1/webhook" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{
        "url": "https://123456.x.pipedream.net"
    }'

Example response :

{
    "id": 1,
    "url": "https://123456.x.pipedream.net",
    "created_at": "2022-09-26T20:18:21.000000Z"
}

Delete webhook

Delete a webhook.

DELETE /api/site-webhook/{id}

Example request :

curl -X DELETE "https://cloud.boxydev.com/api/site-webhook/1" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json"