Webhooks allow you to register custom callbacks that will be called with an HTTP POST request whenever something changes in Ardoq. Webhooks must be enabled by Ardoq for your organization: email us or reach out via chat to request access.

Note: You must be an admin in Ardoq to create webhooks.

Getting Started

Once enabled, you can find the webhooks settings by going to the main menu and selecting Preferences > Organization settings > Settings and navigating to the Webhooks tab.

Select Create Webhook and enter your a name and a destination URL for the webhook to POST to.

You can test your webhook by making a small change in your components like adding and removing a tag.

Request Format

Here's an example POST request made by a webhook:

{
    "resource-type": "tag",
    "resource-id": "cf73fa1e257fdb6a576540e9",
    "event-type": "create",
    "organization": "a8574eb78e6293348cae2d0f",
    "organization-label": "usertesting",
    "data": {
        "description": "",
        "last-updated": "2024-10-17T10:54:46.427Z",
        "_id": "cf73fa1e257fdb6a576540e9",
        "lastModifiedBy": "b28b7a30f64d1642e2b8595a",
        "ardoq-persistent": null,
        "createdBy": "b28b7a30f64d1642e2b8595a",
        "lastModifiedByName": "John G",
        "name": "Test-tag",
        "createdByEmail": "test@ardoq.com",
        "created": "2024-10-17T10:54:46.427Z",
        "rootWorkspace": "48114aeb3832a02710bf8f41",
        "references": [],
        "components": [
            "e0a1be808bc264be4ed3fd2c"
        ],
        "created-by": "b28b7a30f64d1642e2b8595a",
        "last-modified-by": "b28b7a30f64d1642e2b8595a",
        "lastUpdated": "2024-10-17T10:54:46.427Z",
        "origin": null,
        "lastModifiedByEmail": "test@ardoq.com",
        "_version": 1,
        "ardoq": {
            "entity-type": "tag"
        },
        "createdByName": "John G"
    }
}

FAQ

What ports are allowed for egress traffic, and why is port 443 recommended?

It is recommended to use port 443 to ensure traffic is sent over an encrypted channel, enhancing data security.