The Webhook Resource - One Codex Developer Docs

{
  "$uri": "/api/v1/webhooks/0d77065796f8d173",
  "api_version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "event_type": "<string>",
  "post_url": "<string>"
}

Webhooks let your application receive HTTP callbacks when events happen on the One Codex platform — for example, when a sample finishes uploading or an analysis completes. See Using Webhooks for a walkthrough and Checking Webhook Signatures for verification details. The below table summarizes all of the properties for the Webhook resource, with the JSON schema type of each property listed below in italics.

$uri

string

required

read-only

Pattern: ^/api/v1/webhooks/[a-f0-9]{16}$

Example:

"/api/v1/webhooks/0d77065796f8d173"

api_version

string

required

created_at

string<date-time>

required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

enabled

boolean

required

event_type

string

required

post_url

string

required

Checking Signatures Retrieve All Webhooks