Endpoints for managing a team's webhooks

List all webhooks

v1	GET	https://id.amiqus.co/api/webhooks
v2	GET	https://id.amiqus.co/api/v2/webhooks

“List all webhooks” endpoint has been replaced by “Webhooks → List all webhooks” endpoint.

Request:

Added:

• optional query property enabled (boolean).

Response:

Added:

• object of type paginated_list

Changed:

• data.*.object of type webhook (contains an array of objects, so that all properties are nested within this).
• data.*.events now returns an array of string enums.
• active is replaced by data.*.is_enabled (boolean)

Below are examples of responses:

v1

{
    "data": [
        {
            "id": 21,
            "url": "https://httpbin.org/post",
            "events": "record.*",
            "active": true,
            "secret": "dsfhdkjhfjkshfdksjhfksjhaskjhfdskjlhflsdkjh274ab806f74bb34",
            "created_at": "2022-08-24T11:26:22+00:00",
            "updated_at": "2022-08-24T11:26:22+00:00"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}

v2

{
    "object": "paginated_list",
    "data": [
        {
            "object": "webhook",
            "id": 21,
            "uuid": "dhfldksjhflksjaflksjfljsfjlska",
            "url": "https://httpbin.org/post",
            "secret": "dsfhdkjhfjkshfdksjhfksjhaskjhfdskjlhflsdkjh274ab806f74bb34",
            "events": [
                "record.*"
            ],
            "is_enabled": true,
            "created_at": "2022-08-24T11:26:22Z",
            "updated_at": "2022-08-24T11:26:22Z"
        },
    ],
    "total": 1,
    "count": 1,
    "limit": 100,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all webhooks for more information.

Add a new webhook

v1	POST	https://id.amiqus.co/api/webhooks
v2	POST	https://id.amiqus.co/api/v2/webhooks

“Add a new webhook” endpoint has been replaced by “Webhooks → Create a webhook” endpoint.

Request:

Changed

• events now accepts an array of string enums.
• active is replaced by is_enabled (boolean and optional)

Response:

Added:

• object of type webhook

Changed:

• events now returns an array of string enums.
• active is replaced by is_enabled (boolean)

Below are examples of responses:

v1

{
    "id": 21,
    "url": "https://example.org/incoming/webhooks/amiqus",
    "events": "record.*",
    "active": true,
    "secret": "dfjlkdsfjlkdsjfdskljfjkls",
    "created_at": "2022-08-24T11:26:22+00:00",
    "updated_at": "2022-08-24T11:26:22+00:00"
}

v2

{
    "object": "webhook",
    "data": [
        {
            "id": 21,
            "uuid": "ejkldjfldskjflkdsjflkdsj-jfhjdskhfjkdshfjksh",
            "url": "https://example.org/incoming/webhooks/amiqus",
            "secret": "dfjlkdsfjlkdsjfdskljfjkls",
            "events": [
                "record.*"
            ],
            "is_enabled": true,
            "created_at": "2022-08-24T11:26:22Z",
            "updated_at": "2022-08-24T11:26:22Z"
        }
    ]
}

INFO

📌 Please refer to Create a webhook for more information.

Update existing webhook

v1	PUT	https://id.amiqus.co/api/webhooks/{id}
v2	PUT	https://id.amiqus.co/api/v2/webhooks/{id}

“Update existing webhook” endpoint has been replaced by “Webhooks → Update a webhook” endpoint.

Request:

Changed

• events now accepts an array of string enums.
• active is replaced by is_enabled (boolean and optional)

Response:

Added:

• object of type webhook

Changed:

• events now returns an array of string enums.
• active is replaced by is_enabled (boolean)

INFO

📌 Please refer to Update existing webhook for more information.

Delete existing webhook

v1	DELETE	https://id.amiqus.co/api/webhooks/{id}
v2	DELETE	https://id.amiqus.co/api/v2/webhooks/{id}

“Delete existing webhook” endpoint has been replaced by “Webhooks → Delete a webhook” endpoint.

Response:

Changed:

• Successful deletion returns a 204 status code instead of 200.
• Response is now empty.

INFO

📌 Please refer to Delete a webhook for more information.

List webhook deliveries

v1	GET	https://id.amiqus.co/api/webhooks/{id}/deliveries
v2	DELETE	https://id.amiqus.co/api/v2/webhooks/{id}/deliveries

“List webhook deliveries” endpoint has been replaced by “Webhooks → List all deliveries for a webhook” endpoint.

Response:

Added:

• object of type paginated_list

Changed:

• data.*.object of type webhook_delivery with properties nested within this (including id, uuid, event (replaces events), attempts, request, response, last_sent_at
• data.*.object of type WebhookDeliveryRequest with properties nested within this (replacing request)
• data.*.object of type WebhookDeliveryResponse with properties nested within this (replacing response)
• last_sent_at replaces last_delivered_at

Removed:

• status
• failed

Below are examples of responses:

v1

{
    "data": [
        {
            "id": 1,
            "uuid": "add1d2d8-77d8-4d92-9c4c-ac11596ba200",
            "status": "200",
            "failed": false,
            "request": {
                "headers": {
                    "Request URL": "https://httpbin.org/post",
                    "Request method": "POST",
                    "Content-Length": "162",
                    "Host": "httpbin.org",
                    "User-Agent": "Amiqus AmiqusID/...",
                    "Content-Type": "application/json",
                    "X-AQID-Signature": "qOmPQH3XPlhzYvtWivZu35H+GrfoA4/peC/yc2o5U8g=",
                    "X-AQID-Delivery-Id": "add1d2d8-77d8-4d92-9c4c-ac11596ba200"
                },
                "body": {
                    "webhook": {
                        "created_at": "2018-10-01T17:18:51+00:00",
                        "events": [
                            "record.*"
                        ]
                    },
                    "trigger": {
                        "triggered_at": "2018-10-01T17:18:51+00:00",
                        "alias": "ping"
                    },
                    "data": [
                        "ping"
                    ]
                }
            },
            "response": {
                "headers": {
                    "Connection": "keep-alive",
                    "Content-Type": "application/json",
                },
                "body": "..."
            },
            "attempts": 1,
            "last_delivered_at": "2018-10-01T17:18:52+00:00"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}

v2

{
    {
        "object": "paginated_list",
        "data": [
            {
                "object": "webhook_delivery",
                "id": 4532,
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "event": "ping",
                "attempts": 1,
                "request": {
                    "url": "https://example.org/incoming/webhooks/amiqus",
                    "method": "POST",
                    "headers": {
                        "Content-Length": "1234",
                        "Host": "example.org",
                        "User-Agent": "Amiqus AmiqusID/8927532",
                        "Content-Type": "application/json",
                        "X-AQID-Signature": "I4BqQLTTfg1i24UFa9o9wS+qf+lo9BVeuBlO6tS5Y20=",
                        "X-AQID-Delivery-Id": "d7583a16-ad9e-4ec8-a53f-ffc67fd2445c"
                    },
                    "body": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "event": "ping",
                        "sent_at": "2019-08-24T14:15:22Z",
                        "data": [
                            "ping"
                        ]
                    }
                },
                "response": {
                    "status_code": "204",
                    "headers": {
                        "Cache-Control": "no-cache, private",
                        "Date": "Mon, 22 Aug 2022 16:20:33 GMT"
                    },
                    "body": {}
                },
                "last_sent_at": "2019-08-24T14:15:22Z"
            }
        ],
        "total": 1,
        "count": 1,
        "limit": 100,
        "current_page": 1,
        "total_pages": 1,
        "links": null
    }
}

INFO

📌 Please refer to List all deliveries for a webhook for more information.