API reference · 5 endpoints

Webhooks

HMAC-signed event delivery to your endpoints when namespace activity occurs.

POSTRegister webhook/v1/default/namespaces/{namespace_id}/webhooks
GETList webhooks/v1/default/namespaces/{namespace_id}/webhooks
DELETEDelete webhook/v1/default/namespaces/{namespace_id}/webhooks/{webhook_id}
PATCHUpdate webhook/v1/default/namespaces/{namespace_id}/webhooks/{webhook_id}
GETList webhook deliveries/v1/default/namespaces/{namespace_id}/webhooks/{webhook_id}/deliveries

POST/v1/default/namespaces/{namespace_id}/webhooks

Register webhook

Parameters

namespace_idstringpathrequired

Request body · application/json

urlstringrequired

HTTP(S) endpoint URL to deliver events to

secretstring | null

HMAC-SHA256 signing secret (optional)

event_typesstring[]default ["consolidation.completed"]

List of event types to deliver. Currently supported: 'consolidation.completed'

enabledbooleandefault true

Whether this webhook is active

http_configunknown | null

HTTP delivery configuration (method, timeout, headers, params)

curl -X POST "https://api.illumina.sh/v1/default/namespaces/demo/webhooks" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhooks/illumina"
}'

import httpx

response = httpx.post(
    "https://api.illumina.sh/v1/default/namespaces/demo/webhooks",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "url": "https://example.com/webhooks/illumina"
    },
)
print(response.json())

const response = await fetch("https://api.illumina.sh/v1/default/namespaces/demo/webhooks", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ILLUMINA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/webhooks/illumina"
  }),
});
console.log(await response.json());

Response · 201

{
  "id": "ite_123",
  "namespace_id": "demo",
  "url": "https://example.com/webhooks/illumina",
  "event_types": [
    "event types"
  ],
  "enabled": false
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

GET/v1/default/namespaces/{namespace_id}/webhooks

List webhooks

List all webhooks registered for a namespace.

Parameters

namespace_idstringpathrequired

curl -X GET "https://api.illumina.sh/v1/default/namespaces/demo/webhooks" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY"

const response = await fetch("https://api.illumina.sh/v1/default/namespaces/demo/webhooks", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.ILLUMINA_API_KEY}` },
});
console.log(await response.json());

Response · 200

{
  "items": [
    {
      "id": "ite_123",
      "namespace_id": "demo",
      "url": "https://example.com/webhooks/illumina",
      "event_types": [
        "event types"
      ],
      "enabled": false
    }
  ]
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

DELETE/v1/default/namespaces/{namespace_id}/webhooks/{webhook_id}

Delete webhook

Remove a registered webhook.

Parameters

namespace_idstringpathrequired

webhook_idstringpathrequired

curl -X DELETE "https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY"

const response = await fetch("https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.ILLUMINA_API_KEY}` },
});
console.log(await response.json());

Response · 200

{
  "deleted_count": 10,
  "message": "Deleted successfully",
  "success": true
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

PATCH/v1/default/namespaces/{namespace_id}/webhooks/{webhook_id}

Update webhook

Update one or more fields of a registered webhook. Only provided fields are changed.

Parameters

namespace_idstringpathrequired

webhook_idstringpathrequired

Request body · application/json

urlstring | null

HTTP(S) endpoint URL

secretstring | null

HMAC-SHA256 signing secret. Omit to keep existing; send null to clear.

event_typesstring[]

List of event types

enabledboolean | null

Whether this webhook is active

http_configunknown | null

HTTP delivery configuration

curl -X PATCH "https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhooks/illumina",
  "secret": "secret",
  "event_types": [
    "event types"
  ],
  "enabled": false
}'

import httpx

response = httpx.patch(
    "https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "url": "https://example.com/webhooks/illumina",
        "secret": "secret",
        "event_types": [
            "event types"
        ],
        "enabled": False
    },
)
print(response.json())

const response = await fetch("https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.ILLUMINA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/webhooks/illumina",
    "secret": "secret",
    "event_types": [
      "event types"
    ],
    "enabled": false
  }),
});
console.log(await response.json());

Response · 200

{
  "id": "ite_123",
  "namespace_id": "demo",
  "url": "https://example.com/webhooks/illumina",
  "event_types": [
    "event types"
  ],
  "enabled": false
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

GET/v1/default/namespaces/{namespace_id}/webhooks/{webhook_id}/deliveries

List webhook deliveries

Inspect delivery history for a webhook (useful for debugging).

Parameters

namespace_idstringpathrequired

webhook_idstringpathrequired

limitintegerquery

Maximum number of deliveries to return

cursorstring | nullquery

Pagination cursor (created_at of last item)

curl -X GET "https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123/deliveries" \
  -H "Authorization: Bearer $ILLUMINA_API_KEY"

const response = await fetch("https://api.illumina.sh/v1/default/namespaces/demo/webhooks/web_123/deliveries", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.ILLUMINA_API_KEY}` },
});
console.log(await response.json());

Response · 200

{
  "items": [
    {
      "id": "ite_123",
      "webhook_id": "web_123",
      "url": "https://example.com/webhooks/illumina",
      "event_type": "event type",
      "status": "status",
      "attempts": 1
    }
  ]
}

400 · 401 · 402 · 403 · 404 · 405 · 409 · 410 · 422see error reference

Getting started

Core concepts

SDKs & tools

API reference

Resources

Webhooks

Register webhook

Parameters

Request body · application/json

List webhooks

Parameters

Delete webhook

Parameters

Update webhook

Parameters

Request body · application/json

List webhook deliveries

Parameters

Getting started

Core concepts

SDKs & tools

API reference

Resources

Register webhook

Parameters

Request body · application/json

List webhooks

Parameters

Delete webhook

Parameters

Update webhook

Parameters

Request body · application/json

List webhook deliveries

Parameters

Search docs