@epilot/sdk 2.7.10 → 2.7.12

package/dist/webhooks-DTNKNJEN.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/webhooks.json
+var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`testOAuth`](#testoauth)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`WebhookCondition`](#webhookcondition)\n- [`WebhookConditionGroup`](#webhookconditiongroup)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`TestOAuthResponse`](#testoauthresponse)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n  orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n  "algorithm": "ed25519",\n  "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "eventName": "customer_request_created",\n    "eventLabel": "Customer Request Created"\n  }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n  eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "eventName": "CustomerRequest_Created",\n    "url": "https://my-partner-service.api.com",\n    "httpMethod": "POST",\n    "enabled": true,\n    "auth": {\n      "authType": "BASIC",\n      "basicAuthConfig": {\n        "username": "secretUsername",\n        "password": "secret7825@!"\n      }\n    },\n    "filter": {\n      "keyToFilter": "customer_request.productId",\n      "supportedValues": ["2324245", "5253642"]\n    }\n  }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n  null,\n  {\n    eventName: \'CustomerRequest_Created\',\n    url: \'https://my-partner-service.api.com\',\n    httpMethod: \'POST\',\n    enabled: true,\n    auth: {\n      authType: \'BASIC\',\n      basicAuthConfig: {\n        username: \'secretUsername\',\n        password: \'secret7825@!\'\n      }\n    },\n    filter: {\n      keyToFilter: \'customer_request.productId\',\n      supportedValues: [\'2324245\', \'5253642\']\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "eventName": "CustomerRequest_Created",\n  "url": "https://my-partner-service.api.com",\n  "httpMethod": "POST",\n  "enabled": true,\n  "auth": {\n    "authType": "BASIC",\n    "basicAuthConfig": {\n      "username": "secretUsername",\n      "password": "secret7825@!"\n    }\n  },\n  "filter": {\n    "keyToFilter": "customer_request.productId",\n    "supportedValues": ["2324245", "5253642"]\n  }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n  configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "eventName": "CustomerRequest_Created",\n  "url": "https://my-partner-service.api.com",\n  "httpMethod": "POST",\n  "enabled": true,\n  "auth": {\n    "authType": "BASIC",\n    "basicAuthConfig": {\n      "username": "secretUsername",\n      "password": "secret7825@!"\n    }\n  },\n  "filter": {\n    "keyToFilter": "customer_request.productId",\n    "supportedValues": ["2324245", "5253642"]\n  }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n  {\n    configId: \'example\',\n  },\n  {\n    eventName: \'CustomerRequest_Created\',\n    url: \'https://my-partner-service.api.com\',\n    httpMethod: \'POST\',\n    enabled: true,\n    auth: {\n      authType: \'BASIC\',\n      basicAuthConfig: {\n        username: \'secretUsername\',\n        password: \'secret7825@!\'\n      }\n    },\n    filter: {\n      keyToFilter: \'customer_request.productId\',\n      supportedValues: [\'2324245\', \'5253642\']\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "eventName": "CustomerRequest_Created",\n  "url": "https://my-partner-service.api.com",\n  "httpMethod": "POST",\n  "enabled": true,\n  "auth": {\n    "authType": "BASIC",\n    "basicAuthConfig": {\n      "username": "secretUsername",\n      "password": "secret7825@!"\n    }\n  },\n  "filter": {\n    "keyToFilter": "customer_request.productId",\n    "supportedValues": ["2324245", "5253642"]\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n  configId: \'example\',\n})\n```\n\n---\n\n### `testOAuth`\n\nTest OAuth connection\n\n`POST /v1/webhooks/configs/{configId}/test-oauth`\n\n```ts\nconst { data } = await client.testOAuth({\n  configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "success": true,\n  "expires_in": 3600,\n  "token_type": "Bearer",\n  "message": "OAuth token exchange successful"\n}\n```\n\n</details>\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n  {\n    sync: true,\n    configId: \'example\',\n  },\n  {\n    metadata: {\n      action: \'Manual triggered by user with id 123456\',\n      origin: \'string\',\n      creation_timestamp: \'string\',\n      webhook_id: \'string\',\n      webhook_name: \'string\',\n      automation_name: \'string\',\n      organization_id: \'string\',\n      user_id: \'string\',\n      correlation_id: \'string\',\n      execution_id: \'string\',\n      action_id: \'string\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status_code": "string",\n  "message": "string",\n  "body": {},\n  "code": "string",\n  "status": "succeeded",\n  "start_date": "string",\n  "end_date": "string",\n  "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n  {\n    configId: \'example\',\n  },\n  {\n    eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\']\n  },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n  configId: \'example\',\n  eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "event_id": "string",\n  "org_id": "string",\n  "webhook_config_id": "string",\n  "url": "string",\n  "created_at": "2021-04-27T12:01:13.000Z",\n  "event_name": "string",\n  "http_response": {\n    "status_code": 0,\n    "message": "string",\n    "body": {},\n    "code": "string"\n  },\n  "metadata": {\n    "action": "Manual triggered by user with id 123456",\n    "origin": "string",\n    "creation_timestamp": "string",\n    "webhook_id": "string",\n    "webhook_name": "string",\n    "automation_name": "string",\n    "organization_id": "string",\n    "user_id": "string",\n    "correlation_id": "string",\n    "execution_id": "string",\n    "action_id": "string"\n  },\n  "status": "succeeded",\n  "http_method": "GET",\n  "payload": "string",\n  "retry_attempt": 0\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent({\n  configId: \'example\',\n  eventId: \'example\',\n})\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n  {\n    configId: \'example\',\n  },\n  {\n    automation_id: \'automation_123\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "metadata": {\n    "action": "Manual triggered by user with id 123456",\n    "origin": "string",\n    "creation_timestamp": "string",\n    "webhook_id": "string",\n    "webhook_name": "string",\n    "automation_name": "string",\n    "organization_id": "string",\n    "user_id": "string",\n    "correlation_id": "string",\n    "execution_id": "string",\n    "action_id": "string"\n  },\n  "entity": {},\n  "relations": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n  {\n    configId: \'example\',\n  },\n  {\n    limit: 25,\n    cursor: {\n      created_at: \'2025-10-31T12:34:56Z\',\n      event_id: \'evt_1234567890abcdef\'\n    },\n    timestamp: {\n      from: \'2025-10-01T00:00:00Z\',\n      to: \'2025-10-31T23:59:59Z\'\n    },\n    event_id: \'evt_1234567890abcdef\',\n    status: \'succeeded\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "data": [\n    {\n      "event_id": "string",\n      "org_id": "string",\n      "webhook_config_id": "string",\n      "url": "string",\n      "created_at": "2021-04-27T12:01:13.000Z",\n      "event_name": "string",\n      "http_response": {\n        "status_code": 0,\n        "message": "string",\n        "body": {},\n        "code": "string"\n      },\n      "metadata": {\n        "action": "Manual triggered by user with id 123456",\n        "origin": "string",\n        "creation_timestamp": "string",\n        "webhook_id": "string",\n        "webhook_name": "string",\n        "automation_name": "string",\n        "organization_id": "string",\n        "user_id": "string",\n        "correlation_id": "string",\n        "execution_id": "string",\n        "action_id": "string"\n      },\n      "status": "succeeded",\n      "http_method": "GET",\n      "payload": "string",\n      "retry_attempt": 0\n    }\n  ],\n  "next_cursor": {\n    "created_at": "2025-10-31T12:34:56Z",\n    "event_id": "evt_1234567890abcdef"\n  },\n  "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n  public_key: string\n  algorithm: string\n  issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n  limit?: number\n  cursor?: {\n    created_at?: string // date-time\n    event_id?: string\n  }\n  timestamp?: {\n    from?: string // date-time\n    to?: string // date-time\n  }\n  event_id?: string\n  status?: "succeeded" | "failed" | "skipped"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n  data?: Array<{\n    event_id: string\n    org_id: string\n    webhook_config_id: string\n    url?: string\n    created_at?: string\n    event_name?: string\n    http_response?: {\n      status_code?: { ... }\n      message?: { ... }\n      body?: { ... }\n      code?: { ... }\n    }\n    metadata?: {\n      action?: { ... }\n      origin?: { ... }\n      creation_timestamp?: { ... }\n      webhook_id?: { ... }\n      webhook_name?: { ... }\n      automation_name?: { ... }\n      organization_id: { ... }\n      user_id?: { ... }\n      correlation_id?: { ... }\n      execution_id?: { ... }\n      action_id?: { ... }\n    }\n    status?: "succeeded" | "failed" | "in_progress" | "skipped"\n    http_method?: "GET" | "POST" | "PUT"\n    payload?: string\n    retry_attempt?: number\n  }>\n  next_cursor?: {\n    created_at?: string // date-time\n    event_id?: string\n  }\n  has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n  keyToFilter: string\n  supportedValues: string[]\n}\n```\n\n### `WebhookCondition`\n\nA condition that must be met for the webhook to fire.\n\n```ts\ntype WebhookCondition = {\n  field: string\n  operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"\n  values?: string[]\n  field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n  is_array_field?: boolean\n  repeatable_item_op?: boolean\n}\n```\n\n### `WebhookConditionGroup`\n\nA group of conditions with a logical operator. Multiple conditions are AND-ed by default.\n\n```ts\ntype WebhookConditionGroup = {\n  conditions?: Array<{\n    field: string\n    operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"\n    values?: string[]\n    field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n    is_array_field?: boolean\n    repeatable_item_op?: boolean\n  }>\n  logical_operator?: "AND" | "OR"\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n  authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n  basicAuthConfig?: {\n    username: string\n    password?: string\n    passwordIsEnvVar?: boolean\n  }\n  oauthConfig?: {\n    clientId: string\n    clientSecret?: string\n    clientSecretIsEnvVar?: boolean\n    endpoint: string\n    httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n    customParameterList?: Array<{\n      type: { ... }\n      key: { ... }\n      value: { ... }\n    }>\n  }\n  apiKeyConfig?: {\n    keyName: string\n    keyValue?: string\n    keyValueIsEnvVar?: boolean\n  }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n  username: string\n  password?: string\n  passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n  clientId: string\n  clientSecret?: string\n  clientSecretIsEnvVar?: boolean\n  endpoint: string\n  httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n  customParameterList?: Array<{\n    type: "body" | "query" | "header"\n    key: string\n    value: string\n  }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n  keyName: string\n  keyValue?: string\n  keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n  id?: string\n  name: string\n  eventName: string\n  eventVersion?: string\n  url?: string\n  creationTime?: string\n  updatedTime?: string\n  httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n  enabled?: boolean\n  auth?: {\n    authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n    basicAuthConfig?: {\n      username: { ... }\n      password?: { ... }\n      passwordIsEnvVar?: { ... }\n    }\n    oauthConfig?: {\n      clientId: { ... }\n      clientSecret?: { ... }\n      clientSecretIsEnvVar?: { ... }\n      endpoint: { ... }\n      httpMethod: { ... }\n      customParameterList?: { ... }\n    }\n    apiKeyConfig?: {\n      keyName: { ... }\n      keyValue?: { ... }\n      keyValueIsEnvVar?: { ... }\n    }\n  }\n  filter?: {\n    keyToFilter: string\n    supportedValues: string[]\n  }\n  payloadConfiguration?: {\n    hydrate_entity?: boolean\n    include_relations?: boolean\n    include_activity?: boolean\n    include_changed_attributes?: boolean\n    apply_changesets?: boolean\n    custom_headers?: Record<string, string>\n  }\n  enableStaticIP?: boolean\n  protected?: boolean\n  secureProxy?: {\n    integration_id: string // uuid\n    use_case_slug: string\n  }\n  status?: "active" | "inactive" | "incomplete"\n  jsonataExpression?: string\n  deliveryMode?: "json_base64" | "binary_multipart"\n  multipartConfig?: {\n    fileFieldName?: string\n    fileFieldStrategy?: "single" | "multi"\n    fileSource?: string\n    extraFields?: Record<string, string>\n  }\n  retryPolicy?: {\n    enabled: boolean\n    maxAttempts?: number\n  }\n  filterConditions?: {\n    conditions?: Array<{\n      field: { ... }\n      operation: { ... }\n      values?: { ... }\n      field_type?: { ... }\n      is_array_field?: { ... }\n      repeatable_item_op?: { ... }\n    }>\n    logical_operator?: "AND" | "OR"\n  }\n  _manifest?: string // uuid[]\n  signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n  eventName?: string\n  eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n  eventName?: string\n  eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n  message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n  status_code?: string\n  message?: string\n  body?: object\n  code?: string\n  status?: "succeeded" | "failed"\n  start_date?: string\n  end_date?: string\n  event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n  hydrate_entity?: boolean\n  include_relations?: boolean\n  include_activity?: boolean\n  include_changed_attributes?: boolean\n  apply_changesets?: boolean\n  custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n  type: "body" | "query" | "header"\n  key: string\n  value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n  action?: string\n  origin?: string\n  creation_timestamp?: string\n  webhook_id?: string\n  webhook_name?: string\n  automation_name?: string\n  organization_id: string\n  user_id?: string\n  correlation_id?: string\n  execution_id?: string\n  action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n  metadata: {\n    action?: string\n    origin?: string\n    creation_timestamp?: string\n    webhook_id?: string\n    webhook_name?: string\n    automation_name?: string\n    organization_id: string\n    user_id?: string\n    correlation_id?: string\n    execution_id?: string\n    action_id?: string\n  }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n  event_id: string\n  org_id: string\n  webhook_config_id: string\n  url?: string\n  created_at?: string\n  event_name?: string\n  http_response?: {\n    status_code?: number\n    message?: string\n    body?: object\n    code?: string\n  }\n  metadata?: {\n    action?: string\n    origin?: string\n    creation_timestamp?: string\n    webhook_id?: string\n    webhook_name?: string\n    automation_name?: string\n    organization_id: string\n    user_id?: string\n    correlation_id?: string\n    execution_id?: string\n    action_id?: string\n  }\n  status?: "succeeded" | "failed" | "in_progress" | "skipped"\n  http_method?: "GET" | "POST" | "PUT"\n  payload?: string\n  retry_attempt?: number\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n  automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n  metadata?: {\n    action?: string\n    origin?: string\n    creation_timestamp?: string\n    webhook_id?: string\n    webhook_name?: string\n    automation_name?: string\n    organization_id: string\n    user_id?: string\n    correlation_id?: string\n    execution_id?: string\n    action_id?: string\n  }\n  entity?: Record<string, unknown>\n  relations?: Record<string, unknown>[]\n}\n```\n\n### `TestOAuthResponse`\n\n```ts\ntype TestOAuthResponse = {\n  success: boolean\n  expires_in?: number\n  token_type?: string\n  message: string\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n  eventIds: string[]\n}\n```\n';
+export {
+  webhooks_default as default
+};

package/dist/{webhooks.d-ByePoUWs.d.ts → webhooks.d-DKZOMj1P.d.cts}

@@ -526,6 +526,19 @@ declare namespace Components {
             id?: string;
             name: string;
             eventName: string;
+            /**
+             * Pinned schema version of the Event Catalog event this webhook is subscribed to.
+             * Only applicable when `eventName` refers to an Event Catalog event (prefixed with `event_`).
+             * When omitted on creation, it is backfilled lazily on first delivery to match the
+             * event's own `_event_version` (the latest at that time, stamped on the event itself).
+             * Always MAJOR.MINOR (e.g. "1.0", "2.0"), mirroring exactly what event-catalog-api
+             * stamps as `_event_version` and in its `_downgrades[].to` values. Absent for legacy
+             * configs that have not yet received an event.
+             *
+             * example:
+             * 1.0
+             */
+            eventVersion?: string | null; // ^\d+\.\d+$
             url?: string;
             /**
              * Timestamp the webhook was first created. Immutable after creation.
@@ -614,6 +627,26 @@ declare namespace Components {
                     [name: string]: string;
                 };
             };
+            /**
+             * Automatic-retry policy for transient delivery failures (5xx, 429,
+             * connection-level errors). Newly-created webhooks are materialized
+             * with defaults (`enabled: true`, `maxAttempts: 3`). Webhooks created
+             * before this feature have no policy and are treated as disabled — on
+             * update, omit this field to preserve the existing value. The backoff
+             * curve is a fixed Standard Webhooks schedule (5s, 5m, 30m, 2h, 5h);
+             * only the first `maxAttempts` intervals are used.
+             *
+             */
+            retryPolicy?: {
+                /**
+                 * Master on/off switch for automatic retries.
+                 */
+                enabled: boolean;
+                /**
+                 * Maximum number of automatic retries after the initial delivery attempt.
+                 */
+                maxAttempts?: number;
+            };
             filterConditions?: /* A group of conditions with a logical operator. Multiple conditions are AND-ed by default. */ WebhookConditionGroup;
             /**
              * Manifest ID used to create/update the webhook resource
@@ -656,6 +689,10 @@ declare namespace Components {
              * stringified payload of the webhook request
              */
             payload?: string;
+            /**
+             * Number of automatic delivery retries that preceded this terminal outcome. 0 means the event was delivered (or finally failed) on the first attempt.
+             */
+            retry_attempt?: number;
         }
     }
 }

package/dist/{webhooks.d-ByePoUWs.d.cts → webhooks.d-DKZOMj1P.d.ts}

@@ -526,6 +526,19 @@ declare namespace Components {
             id?: string;
             name: string;
             eventName: string;
+            /**
+             * Pinned schema version of the Event Catalog event this webhook is subscribed to.
+             * Only applicable when `eventName` refers to an Event Catalog event (prefixed with `event_`).
+             * When omitted on creation, it is backfilled lazily on first delivery to match the
+             * event's own `_event_version` (the latest at that time, stamped on the event itself).
+             * Always MAJOR.MINOR (e.g. "1.0", "2.0"), mirroring exactly what event-catalog-api
+             * stamps as `_event_version` and in its `_downgrades[].to` values. Absent for legacy
+             * configs that have not yet received an event.
+             *
+             * example:
+             * 1.0
+             */
+            eventVersion?: string | null; // ^\d+\.\d+$
             url?: string;
             /**
              * Timestamp the webhook was first created. Immutable after creation.
@@ -614,6 +627,26 @@ declare namespace Components {
                     [name: string]: string;
                 };
             };
+            /**
+             * Automatic-retry policy for transient delivery failures (5xx, 429,
+             * connection-level errors). Newly-created webhooks are materialized
+             * with defaults (`enabled: true`, `maxAttempts: 3`). Webhooks created
+             * before this feature have no policy and are treated as disabled — on
+             * update, omit this field to preserve the existing value. The backoff
+             * curve is a fixed Standard Webhooks schedule (5s, 5m, 30m, 2h, 5h);
+             * only the first `maxAttempts` intervals are used.
+             *
+             */
+            retryPolicy?: {
+                /**
+                 * Master on/off switch for automatic retries.
+                 */
+                enabled: boolean;
+                /**
+                 * Maximum number of automatic retries after the initial delivery attempt.
+                 */
+                maxAttempts?: number;
+            };
             filterConditions?: /* A group of conditions with a logical operator. Multiple conditions are AND-ed by default. */ WebhookConditionGroup;
             /**
              * Manifest ID used to create/update the webhook resource
@@ -656,6 +689,10 @@ declare namespace Components {
              * stringified payload of the webhook request
              */
             payload?: string;
+            /**
+             * Number of automatic delivery retries that preceded this terminal outcome. 0 means the event was delivered (or finally failed) on the first attempt.
+             */
+            retry_attempt?: number;
         }
     }
 }

package/docs/event-catalog.md

@@ -30,6 +30,7 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`patchEvent`](#patchevent)
 - [`getEventJSONSchema`](#geteventjsonschema)
 - [`getEventExample`](#geteventexample)
+- [`listEventVersions`](#listeventversions)
 - [`searchEventHistory`](#searcheventhistory)
 - [`searchEventHistoryV2`](#searcheventhistoryv2)
 - [`getHistoricalEvent`](#gethistoricalevent)
@@ -57,6 +58,9 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`TriggerEventPayload`](#triggereventpayload)
 - [`TriggerEventResponse`](#triggereventresponse)
 - [`EventAttachment`](#eventattachment)
+- [`FieldChange`](#fieldchange)
+- [`VersionMeta`](#versionmeta)
+- [`EventVersionRegistrySummary`](#eventversionregistrysummary)
 
 ### `listEvents`
 
@@ -78,7 +82,7 @@ const { data } = await client.listEvents()
       "event_name": "AddMeterReading",
       "event_title": "Add Meter Reading",
       "event_description": "Triggered when a new meter reading is added",
-      "event_version": "1.0.0",
+      "event_version": "1.0",
       "event_status": "active",
       "event_tags": ["builtin", "metering", "erp"],
       "schema_fields": {},
@@ -136,7 +140,7 @@ const { data } = await client.getEvent({
   "event_name": "AddMeterReading",
   "event_title": "Add Meter Reading",
   "event_description": "Triggered when a new meter reading is added",
-  "event_version": "1.0.0",
+  "event_version": "1.0",
   "event_status": "active",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
@@ -187,7 +191,7 @@ const { data } = await client.patchEvent(
     event_name: 'AddMeterReading',
     event_title: 'Add Meter Reading',
     event_description: 'Triggered when a new meter reading is added',
-    event_version: '1.0.0',
+    event_version: '1.0',
     event_status: 'active',
     event_tags: ['builtin', 'metering', 'erp'],
     schema_fields: {},
@@ -228,7 +232,7 @@ const { data } = await client.patchEvent(
   "event_name": "AddMeterReading",
   "event_title": "Add Meter Reading",
   "event_description": "Triggered when a new meter reading is added",
-  "event_version": "1.0.0",
+  "event_version": "1.0",
   "event_status": "active",
   "event_tags": ["builtin", "metering", "erp"],
   "schema_fields": {},
@@ -266,13 +270,16 @@ const { data } = await client.patchEvent(
 
 ### `getEventJSONSchema`
 
-Retrieve the JSON Schema of a specific business event
+Retrieve the JSON Schema of a specific business event. Pass an optional
+`Epilot-Event-Version` header to retrieve a specific version's schema;
+when omitted, the event's latest version is returned.
 
 `GET /v1/events/{event_name}/json_schema`
 
 ```ts
 const { data } = await client.getEventJSONSchema({
   event_name: 'example',
+  Epilot-Event-Version: 'example',
 })
 ```
 
@@ -302,7 +309,7 @@ const { data } = await client.getEventJSONSchema({
     },
     "_event_version": {
       "type": "string",
-      "description": "Event version (semver)"
+      "description": "Event payload version (MAJOR.MINOR)"
     },
     "_event_source": {
       "type": "string",
@@ -388,13 +395,16 @@ const { data } = await client.getEventJSONSchema({
 
 ### `getEventExample`
 
-Generate a sample event payload based on the event's JSON Schema
+Generate a sample event payload based on the event's JSON Schema. Pass an
+optional `Epilot-Event-Version` header to generate the example for a
+specific version; when omitted, the event's latest versio
 
 `GET /v1/events/{event_name}/example`
 
 ```ts
 const { data } = await client.getEventExample({
   event_name: 'example',
+  Epilot-Event-Version: 'example',
 })
 ```
 
@@ -409,6 +419,50 @@ const { data } = await client.getEventExample({
 
 ---
 
+### `listEventVersions`
+
+List every known version of an event, along with the `latest`
+and the set of currently `active` versions. See §3.2 of the
+Event Payload Versioning RFC.
+
+`GET /v1/events/{event_name}/versions`
+
+```ts
+const { data } = await client.listEventVersions({
+  event_name: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "event_name": "MeterReadingAdded",
+  "latest": "1.0",
+  "versions": [
+    {
+      "version": "1.0",
+      "released_at": "2025-11-15",
+      "change_summary": "string",
+      "change_notes": "string",
+      "changes": [
+        {
+          "field": "reading",
+          "op": "added",
+          "type_old": "string",
+          "type_new": "string"
+        }
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `searchEventHistory`
 
 Paginated history of events
@@ -446,7 +500,7 @@ const { data } = await client.searchEventHistory(
       "_event_time": "2024-01-01T12:00:00Z",
       "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
       "_event_name": "MeterReading",
-      "_event_version": "1.0.0",
+      "_event_version": "1.0",
       "_event_source": "api",
       "_trigger_source_type": "api",
       "_trigger_source": "user_123456",
@@ -514,7 +568,7 @@ const { data } = await client.searchEventHistoryV2(
       "_event_time": "1970-01-01T00:00:00.000Z",
       "_event_id": "string",
       "_event_name": "string",
-      "_event_version": "1.0.0",
+      "_event_version": "1.0",
       "_event_source": "string",
       "_trigger_source_type": "api",
       "_trigger_source": "string",
@@ -554,7 +608,7 @@ const { data } = await client.getHistoricalEvent({
   "_event_time": "2024-01-01T12:00:00Z",
   "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
   "_event_name": "MeterReading",
-  "_event_version": "1.0.0",
+  "_event_version": "1.0",
   "_event_source": "api",
   "_trigger_source_type": "api",
   "_trigger_source": "user_123456",
@@ -899,9 +953,9 @@ type Event = {
 A lightweight event summary returned by the v2 history endpoint.
 
 Includes the standard `_*` metadata fields plus a projected subset of the
-event payload. Hydrated entity objects (values carrying `_schema` or `_id`
-and arrays of such objects) are stripped — fetch via
-`GET /v2/events/{event_name}/his
+event payload. Hydrated entity objects (values carrying `_schema` or `_id`)
+— and arrays of such objects — are reduced to reference stubs
+`{_schema, _id, _title
 
 ```ts
 type EventSummary = {
@@ -1079,3 +1133,62 @@ type EventAttachment = {
   readable_size?: string
 }
 ```
+
+### `FieldChange`
+
+A field-level change descriptor. Powers the declarative half of the
+version DSL.
+
+
+```ts
+type FieldChange = {
+  field: string
+  op: "added" | "removed" | "type-changed"
+  type_old?: string
+  type_new?: string
+}
+```
+
+### `VersionMeta`
+
+One entry of an event's version timeline.
+
+```ts
+type VersionMeta = {
+  version: string
+  released_at: string
+  change_summary: string
+  change_notes?: string
+  changes: Array<{
+    field: string
+    op: "added" | "removed" | "type-changed"
+    type_old?: string
+    type_new?: string
+  }>
+}
+```
+
+### `EventVersionRegistrySummary`
+
+Summary of an event's version timeline returned by
+`GET /v1/events/{event_name}/versions`.
+
+
+```ts
+type EventVersionRegistrySummary = {
+  event_name: string
+  latest: string
+  versions: Array<{
+    version: string
+    released_at: string
+    change_summary: string
+    change_notes?: string
+    changes: Array<{
+      field: { ... }
+      op: { ... }
+      type_old?: { ... }
+      type_new?: { ... }
+    }>
+  }>
+}
+```

package/docs/webhooks.md

@@ -475,7 +475,8 @@ const { data } = await client.getEventById({
   },
   "status": "succeeded",
   "http_method": "GET",
-  "payload": "string"
+  "payload": "string",
+  "retry_attempt": 0
 }
 ```
 
@@ -605,7 +606,8 @@ const { data } = await client.getWebhookEventsV2(
       },
       "status": "succeeded",
       "http_method": "GET",
-      "payload": "string"
+      "payload": "string",
+      "retry_attempt": 0
     }
   ],
   "next_cursor": {
@@ -683,6 +685,7 @@ type EventListResponse = {
     status?: "succeeded" | "failed" | "in_progress" | "skipped"
     http_method?: "GET" | "POST" | "PUT"
     payload?: string
+    retry_attempt?: number
   }>
   next_cursor?: {
     created_at?: string // date-time
@@ -826,6 +829,7 @@ type WebhookConfig = {
   id?: string
   name: string
   eventName: string
+  eventVersion?: string
   url?: string
   creationTime?: string
   updatedTime?: string
@@ -879,6 +883,10 @@ type WebhookConfig = {
     fileSource?: string
     extraFields?: Record<string, string>
   }
+  retryPolicy?: {
+    enabled: boolean
+    maxAttempts?: number
+  }
   filterConditions?: {
     conditions?: Array<{
       field: { ... }
@@ -1045,6 +1053,7 @@ type WebhookEvent = {
   status?: "succeeded" | "failed" | "in_progress" | "skipped"
   http_method?: "GET" | "POST" | "PUT"
   payload?: string
+  retry_attempt?: number
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.7.10",
+  "version": "2.7.12",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -316,16 +316,6 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix",
-    "prepublishOnly": "npm run build"
-  },
   "keywords": [
     "epilot",
     "sdk",
@@ -516,5 +506,14 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
+  },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix"
   }
-}
+}

package/definitions/focus-pocus-runtime.json

@@ -1 +0,0 @@
-{"s":"https://focus-pocus.dev.sls.epilot.io","o":[["getHealth","get","/v1/health"],["listAchievements","get","/v1/achievements"],["getAchievement","get","/v1/achievements/{id}",[["AchievementOrChallengeId"]]],["getSuggestedChallenge","get","/v1/challenges/suggest",[["route","q"],["entity_type","q"],["category_hint","q"]]],["acceptChallenge","post","/v1/challenges/{id}/accept",[["ChallengeId"]]],["dismissChallenge","post","/v1/challenges/{id}/dismiss",[["ChallengeId"]]],["listActiveChallenges","get","/v1/challenges/active"],["postEvent","post","/v1/events",null,1]],"v":"3.0.3","cp":{"AchievementId":["id","p",true],"AchievementOrChallengeId":["id","p",true],"ChallengeId":["id","p",true],"Cursor":["cursor","q"],"Size":["size","q"]}}