@epilot/sdk 2.1.4 → 2.1.6

package/dist/webhooks-H3RT33BF.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// 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- [`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- [`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### `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}\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    }\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  }>\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  url?: string\n  creationTime?: 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    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  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  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}\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### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n  eventIds: string[]\n}\n```\n';
+
+
+exports.default = webhooks_default;

package/dist/webhooks-RTOU3MS5.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- [`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- [`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### `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}\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    }\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  }>\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  url?: string\n  creationTime?: 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    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  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  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}\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### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n  eventIds: string[]\n}\n```\n';
+export {
+  webhooks_default as default
+};

package/dist/{webhooks.d-CUNJrltY.d.ts → webhooks.d-pLHIL_io.d.cts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
 
 /* Auto-copied from webhooks-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -401,7 +399,7 @@ declare namespace Components {
              * example:
              * succeeded
              */
-            status?: "succeeded" | "failed";
+            status?: "succeeded" | "failed" | "skipped";
         }
         export interface TriggerWebhookResp {
             status_code?: string;
@@ -415,6 +413,50 @@ declare namespace Components {
             end_date?: string;
             event_id: string;
         }
+        /**
+         * A condition that must be met for the webhook to fire.
+         */
+        export interface WebhookCondition {
+            /**
+             * Dot-notation path to the field in the event payload (e.g. "entity.status", "entity.line_items")
+             */
+            field: string;
+            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";
+            /**
+             * Values to compare against (not required for is_empty/is_not_empty)
+             */
+            values?: string[];
+            /**
+             * Type hint for the field (affects comparison logic)
+             */
+            field_type?: "string" | "number" | "boolean" | "date" | "datetime";
+            /**
+             * Whether the target field is an array (repeatable)
+             */
+            is_array_field?: boolean;
+            /**
+             * When true, evaluates conditions per-item in repeatable array fields
+             */
+            repeatable_item_op?: boolean;
+        }
+        /**
+         * A group of conditions with a logical operator. Multiple conditions are AND-ed by default.
+         */
+        export interface WebhookConditionGroup {
+            conditions?: [
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?
+            ];
+            logical_operator?: "AND" | "OR";
+        }
         /**
          * example:
          * {
@@ -455,11 +497,23 @@ declare namespace Components {
             filter?: Filter;
             payloadConfiguration?: /* Configuration for the webhook payload */ PayloadConfiguration;
             enableStaticIP?: boolean;
+            /**
+             * When true, indicates this webhook configuration is protected and should not be modified without explicit intent.
+             */
+            protected?: boolean;
+            /**
+             * Routes webhook requests through a secure VPC proxy (ERP integration service). When set, takes precedence over enableStaticIP.
+             */
+            secureProxy?: {
+                integration_id: string; // uuid
+                use_case_slug: string;
+            };
             status?: "active" | "inactive" | "incomplete";
             /**
              * JSONata expression to transform the payload
              */
             jsonataExpression?: string;
+            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
              */
@@ -495,7 +549,7 @@ declare namespace Components {
                 code?: string;
             };
             metadata?: /* Contains the metadata about the configured event */ Metadata;
-            status?: "succeeded" | "failed" | "in_progress";
+            status?: "succeeded" | "failed" | "in_progress" | "skipped";
             http_method?: "GET" | "POST" | "PUT";
             /**
              * stringified payload of the webhook request
@@ -1194,7 +1248,9 @@ type PayloadConfiguration = Components.Schemas.PayloadConfiguration;
 type PublicKeyResponse = Components.Schemas.PublicKeyResponse;
 type SearchOptions = Components.Schemas.SearchOptions;
 type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
+type WebhookCondition = Components.Schemas.WebhookCondition;
+type WebhookConditionGroup = Components.Schemas.WebhookConditionGroup;
 type WebhookConfig = Components.Schemas.WebhookConfig;
 type WebhookEvent = Components.Schemas.WebhookEvent;
 
-export { type ApiKeyConfig as A, type BasicAuthConfig as B, type Client as C, type ErrorResp as E, type Filter as F, type HttpMethod as H, type Metadata as M, type OperationMethods as O, Paths as P, type SearchOptions as S, type TriggerWebhookResp as T, type WebhookConfig as W, Components as a, type PathsDictionary as b, type Auth as c, type AuthType as d, type BatchReplayRequest as e, type CustomHeader as f, type CustomOAuthParameter as g, type EventConfigEntry as h, type EventConfigResp as i, type EventListResponse as j, type ExampleRequest as k, type ExampleResponse as l, type ExecutionPayload as m, type OAuthConfig as n, type PayloadConfiguration as o, type PublicKeyResponse as p, type WebhookEvent as q };
+export { type ApiKeyConfig as A, type BasicAuthConfig as B, type Client as C, type ErrorResp as E, type Filter as F, type HttpMethod as H, type Metadata as M, type OperationMethods as O, Paths as P, type SearchOptions as S, type TriggerWebhookResp as T, type WebhookCondition as W, Components as a, type PathsDictionary as b, type Auth as c, type AuthType as d, type BatchReplayRequest as e, type CustomHeader as f, type CustomOAuthParameter as g, type EventConfigEntry as h, type EventConfigResp as i, type EventListResponse as j, type ExampleRequest as k, type ExampleResponse as l, type ExecutionPayload as m, type OAuthConfig as n, type PayloadConfiguration as o, type PublicKeyResponse as p, type WebhookConditionGroup as q, type WebhookConfig as r, type WebhookEvent as s };

package/dist/{webhooks.d-CUNJrltY.d.cts → webhooks.d-pLHIL_io.d.ts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
 
 /* Auto-copied from webhooks-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -401,7 +399,7 @@ declare namespace Components {
              * example:
              * succeeded
              */
-            status?: "succeeded" | "failed";
+            status?: "succeeded" | "failed" | "skipped";
         }
         export interface TriggerWebhookResp {
             status_code?: string;
@@ -415,6 +413,50 @@ declare namespace Components {
             end_date?: string;
             event_id: string;
         }
+        /**
+         * A condition that must be met for the webhook to fire.
+         */
+        export interface WebhookCondition {
+            /**
+             * Dot-notation path to the field in the event payload (e.g. "entity.status", "entity.line_items")
+             */
+            field: string;
+            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";
+            /**
+             * Values to compare against (not required for is_empty/is_not_empty)
+             */
+            values?: string[];
+            /**
+             * Type hint for the field (affects comparison logic)
+             */
+            field_type?: "string" | "number" | "boolean" | "date" | "datetime";
+            /**
+             * Whether the target field is an array (repeatable)
+             */
+            is_array_field?: boolean;
+            /**
+             * When true, evaluates conditions per-item in repeatable array fields
+             */
+            repeatable_item_op?: boolean;
+        }
+        /**
+         * A group of conditions with a logical operator. Multiple conditions are AND-ed by default.
+         */
+        export interface WebhookConditionGroup {
+            conditions?: [
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?,
+                /* A condition that must be met for the webhook to fire. */ WebhookCondition?
+            ];
+            logical_operator?: "AND" | "OR";
+        }
         /**
          * example:
          * {
@@ -455,11 +497,23 @@ declare namespace Components {
             filter?: Filter;
             payloadConfiguration?: /* Configuration for the webhook payload */ PayloadConfiguration;
             enableStaticIP?: boolean;
+            /**
+             * When true, indicates this webhook configuration is protected and should not be modified without explicit intent.
+             */
+            protected?: boolean;
+            /**
+             * Routes webhook requests through a secure VPC proxy (ERP integration service). When set, takes precedence over enableStaticIP.
+             */
+            secureProxy?: {
+                integration_id: string; // uuid
+                use_case_slug: string;
+            };
             status?: "active" | "inactive" | "incomplete";
             /**
              * JSONata expression to transform the payload
              */
             jsonataExpression?: string;
+            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
              */
@@ -495,7 +549,7 @@ declare namespace Components {
                 code?: string;
             };
             metadata?: /* Contains the metadata about the configured event */ Metadata;
-            status?: "succeeded" | "failed" | "in_progress";
+            status?: "succeeded" | "failed" | "in_progress" | "skipped";
             http_method?: "GET" | "POST" | "PUT";
             /**
              * stringified payload of the webhook request
@@ -1194,7 +1248,9 @@ type PayloadConfiguration = Components.Schemas.PayloadConfiguration;
 type PublicKeyResponse = Components.Schemas.PublicKeyResponse;
 type SearchOptions = Components.Schemas.SearchOptions;
 type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
+type WebhookCondition = Components.Schemas.WebhookCondition;
+type WebhookConditionGroup = Components.Schemas.WebhookConditionGroup;
 type WebhookConfig = Components.Schemas.WebhookConfig;
 type WebhookEvent = Components.Schemas.WebhookEvent;
 
-export { type ApiKeyConfig as A, type BasicAuthConfig as B, type Client as C, type ErrorResp as E, type Filter as F, type HttpMethod as H, type Metadata as M, type OperationMethods as O, Paths as P, type SearchOptions as S, type TriggerWebhookResp as T, type WebhookConfig as W, Components as a, type PathsDictionary as b, type Auth as c, type AuthType as d, type BatchReplayRequest as e, type CustomHeader as f, type CustomOAuthParameter as g, type EventConfigEntry as h, type EventConfigResp as i, type EventListResponse as j, type ExampleRequest as k, type ExampleResponse as l, type ExecutionPayload as m, type OAuthConfig as n, type PayloadConfiguration as o, type PublicKeyResponse as p, type WebhookEvent as q };
+export { type ApiKeyConfig as A, type BasicAuthConfig as B, type Client as C, type ErrorResp as E, type Filter as F, type HttpMethod as H, type Metadata as M, type OperationMethods as O, Paths as P, type SearchOptions as S, type TriggerWebhookResp as T, type WebhookCondition as W, Components as a, type PathsDictionary as b, type Auth as c, type AuthType as d, type BatchReplayRequest as e, type CustomHeader as f, type CustomOAuthParameter as g, type EventConfigEntry as h, type EventConfigResp as i, type EventListResponse as j, type ExampleRequest as k, type ExampleResponse as l, type ExecutionPayload as m, type OAuthConfig as n, type PayloadConfiguration as o, type PublicKeyResponse as p, type WebhookConditionGroup as q, type WebhookConfig as r, type WebhookEvent as s };

package/docs/app.md

@@ -399,7 +399,8 @@ const { data } = await client.getPublicConfiguration({
   },
   "blueprint_ref": {
     "manifest_id": "string",
-    "job_id": "string"
+    "job_id": "string",
+    "source_blueprint_file": "string"
   },
   "latest_version": "string",
   "public": true,
@@ -519,7 +520,8 @@ const { data } = await client.getConfiguration({
   },
   "blueprint_ref": {
     "manifest_id": "string",
-    "job_id": "string"
+    "job_id": "string",
+    "source_blueprint_file": "string"
   },
   "version_audit": {
     "created_at": "string",
@@ -877,7 +879,8 @@ const { data } = await client.listVersions({
       },
       "blueprint_ref": {
         "manifest_id": "string",
-        "job_id": "string"
+        "job_id": "string",
+        "source_blueprint_file": "string"
       },
       "version_audit": {
         "created_at": "string",
@@ -992,7 +995,8 @@ const { data } = await client.getVersion({
   },
   "blueprint_ref": {
     "manifest_id": "string",
-    "job_id": "string"
+    "job_id": "string",
+    "source_blueprint_file": "string"
   },
   "version_audit": {
     "created_at": "string",
@@ -1328,7 +1332,8 @@ const { data } = await client.listInstallations({
       "role": "string",
       "blueprint_ref": {
         "manifest_id": "string",
-        "job_id": "string"
+        "job_id": "string",
+        "source_blueprint_file": "string"
       },
       "installation_audit": {
         "created_at": "string",
@@ -1407,7 +1412,8 @@ const { data } = await client.getInstallation({
   "role": "string",
   "blueprint_ref": {
     "manifest_id": "string",
-    "job_id": "string"
+    "job_id": "string",
+    "source_blueprint_file": "string"
   },
   "installation_audit": {
     "created_at": "string",
@@ -1496,7 +1502,8 @@ const { data } = await client.install(
   "role": "string",
   "blueprint_ref": {
     "manifest_id": "string",
-    "job_id": "string"
+    "job_id": "string",
+    "source_blueprint_file": "string"
   },
   "installation_audit": {
     "created_at": "string",
@@ -1614,7 +1621,8 @@ const { data } = await client.promoteVersion({
   "role": "string",
   "blueprint_ref": {
     "manifest_id": "string",
-    "job_id": "string"
+    "job_id": "string",
+    "source_blueprint_file": "string"
   },
   "installation_audit": {
     "created_at": "string",
@@ -1888,7 +1896,7 @@ type PortalBlockComponent = {
       app_url?: { ... }
       zip_url?: { ... }
       override_url?: { ... }
-      section?: { ... }
+      supported_surfaces?: { ... }
     }
   }
 }
@@ -2721,7 +2729,7 @@ type PortalBlockSurfaceConfig = {
   app_url?: string
   zip_url?: string
   override_url?: string
-  section?: "main" | "footer"
+  supported_surfaces?: "main" | "footer_inline" | "footer_left_absolute" | "footer_right_absolute"[]
 }
 ```
 
@@ -2907,6 +2915,7 @@ type ConfigurationVersion = {
   blueprint_ref?: {
     manifest_id?: string
     job_id?: string
+    source_blueprint_file?: string
   }
   version_audit: {
     created_at?: string
@@ -2936,6 +2945,7 @@ type Grants = Array<{
 type BlueprintRef = {
   manifest_id?: string
   job_id?: string
+  source_blueprint_file?: string
 }
 ```
 
@@ -2982,6 +2992,7 @@ type Installation = {
   blueprint_ref?: {
     manifest_id?: string
     job_id?: string
+    source_blueprint_file?: string
   }
   installation_audit?: {
     created_at?: string
@@ -3053,6 +3064,7 @@ type PublicConfiguration = {
   blueprint_ref?: {
     manifest_id?: string
     job_id?: string
+    source_blueprint_file?: string
   }
   latest_version?: string
   public?: boolean
@@ -3081,6 +3093,7 @@ type PublicConfiguration = {
     blueprint_ref?: {
       manifest_id?: { ... }
       job_id?: { ... }
+      source_blueprint_file?: { ... }
     }
     version_audit: {
       created_at?: { ... }
@@ -3173,6 +3186,7 @@ type Configuration = {
   blueprint_ref?: {
     manifest_id?: string
     job_id?: string
+    source_blueprint_file?: string
   }
   version_audit: {
     created_at?: string

package/docs/webhooks.md

@@ -48,6 +48,8 @@ const { data } = await webhooksClient.getPublicKey(...)
 - [`HttpMethod`](#httpmethod)
 - [`AuthType`](#authtype)
 - [`Filter`](#filter)
+- [`WebhookCondition`](#webhookcondition)
+- [`WebhookConditionGroup`](#webhookconditiongroup)
 - [`Auth`](#auth)
 - [`BasicAuthConfig`](#basicauthconfig)
 - [`OAuthConfig`](#oauthconfig)
@@ -614,7 +616,7 @@ type SearchOptions = {
     to?: string // date-time
   }
   event_id?: string
-  status?: "succeeded" | "failed"
+  status?: "succeeded" | "failed" | "skipped"
 }
 ```
 
@@ -648,7 +650,7 @@ type EventListResponse = {
       execution_id?: { ... }
       action_id?: { ... }
     }
-    status?: "succeeded" | "failed" | "in_progress"
+    status?: "succeeded" | "failed" | "in_progress" | "skipped"
     http_method?: "GET" | "POST" | "PUT"
     payload?: string
   }>
@@ -681,6 +683,39 @@ type Filter = {
 }
 ```
 
+### `WebhookCondition`
+
+A condition that must be met for the webhook to fire.
+
+```ts
+type WebhookCondition = {
+  field: string
+  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"
+  values?: string[]
+  field_type?: "string" | "number" | "boolean" | "date" | "datetime"
+  is_array_field?: boolean
+  repeatable_item_op?: boolean
+}
+```
+
+### `WebhookConditionGroup`
+
+A group of conditions with a logical operator. Multiple conditions are AND-ed by default.
+
+```ts
+type WebhookConditionGroup = {
+  conditions?: Array<{
+    field: string
+    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"
+    values?: string[]
+    field_type?: "string" | "number" | "boolean" | "date" | "datetime"
+    is_array_field?: boolean
+    repeatable_item_op?: boolean
+  }>
+  logical_operator?: "AND" | "OR"
+}
+```
+
 ### `Auth`
 
 ```ts
@@ -798,8 +833,24 @@ type WebhookConfig = {
     custom_headers?: Record<string, string>
   }
   enableStaticIP?: boolean
+  protected?: boolean
+  secureProxy?: {
+    integration_id: string // uuid
+    use_case_slug: string
+  }
   status?: "active" | "inactive" | "incomplete"
   jsonataExpression?: string
+  filterConditions?: {
+    conditions?: Array<{
+      field: { ... }
+      operation: { ... }
+      values?: { ... }
+      field_type?: { ... }
+      is_array_field?: { ... }
+      repeatable_item_op?: { ... }
+    }>
+    logical_operator?: "AND" | "OR"
+  }
   _manifest?: string // uuid[]
   signingSecret?: string
 }
@@ -951,7 +1002,7 @@ type WebhookEvent = {
     execution_id?: string
     action_id?: string
   }
-  status?: "succeeded" | "failed" | "in_progress"
+  status?: "succeeded" | "failed" | "in_progress" | "skipped"
   http_method?: "GET" | "POST" | "PUT"
   payload?: string
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.1.4",
+  "version": "2.1.6",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",