> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.withpersona.com/2020-05-18/api-reference/webhooks/importer-pipeline-run-events/webhook-importer-pipeline-run-started/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server. # Importer pipeline run started POST Webhook for the `importer-pipeline-run.started` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks). Reference: https://docs.withpersona.com/api-reference/webhooks/importer-pipeline-run-events/webhook-importer-pipeline-run-started ## Request ### Headers - `Persona-Signature` (string, optional) — Header. An HMAC that you should use to check that requests are authentic. Compare this value with your own digest, computed from the request body and your webhook secret. For more info see [Webhook Best Practices](https://docs.withpersona.com/webhooks-best-practices). - `Persona-Webhook-Attempts-Made` (integer, optional) — The number of times that Persona has attempted to deliver this webhook. This value is incremented each time Persona attempts to deliver the webhook, regardless of whether the delivery was successful. - `Persona-Webhook-Attempts-Left` (integer, optional) — The number of times that Persona will attempt to deliver this webhook. This value is decremented each time Persona attempts to deliver the webhook. - `Persona-Webhook-First-Attempted-At` (integer, optional) — The time at which Persona first attempted to deliver this webhook. This value is a Unix timestamp in seconds. ### Payload - `data` (WebhooksWebhookImporterPipelineRunStartedPayloadContentApplicationJsonSchemaData, optional) ## Types ### WebhooksWebhookImporterPipelineRunStartedPayloadContentApplicationJsonSchemaData - `attributes` (WebhooksWebhookImporterPipelineRunStartedPayloadContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) — Unique identifier for this Event. Starts with `evt_`. - `type` ("event", optional) ### WebhooksWebhookImporterPipelineRunStartedPayloadContentApplicationJsonSchemaDataAttributes - `created-at` (datetime, optional) — Datetime when the event was created. - `name` ("importer-pipeline-run.started", optional) - `payload` (WebhooksWebhookImporterPipelineRunStartedPayloadContentApplicationJsonSchemaDataAttributesPayload, optional) ### WebhooksWebhookImporterPipelineRunStartedPayloadContentApplicationJsonSchemaDataAttributesPayload - `data` (importer-pipeline-run, optional) — An Importer Pipeline Run object. - `included` (list of ImporterPipelineRunsIncludedObjectsItems, optional) — All objects that are present in `data.attributes.relationships` will be provided in `included`. ### importer-pipeline-run An Importer Pipeline Run object. - `type` ("importer-pipeline-run", optional) - `id` (string, optional) - `attributes` (ImporterPipelineRunAttributes, optional) - `relationships` (ImporterPipelineRunRelationships, optional) ### ImporterPipelineRunsIncludedObjectsItems - `type`: `importer-pipeline` (importer-pipeline) - `attributes` (ImporterPipelineRunsIncludedObjectsItemsDiscriminatorMappingImporterPipelineAttributes, optional) - `id` (string, optional) ### ImporterPipelineRunAttributes - `reference-id` (string, optional, nullable) — Reference identifier for the pipeline run - `status` (string, optional) — Current status of the pipeline run. Possible values include `pending`, `running`, `paused`, `canceled`, `completed`, `errored`, and `killed`. - `run-count` (integer, optional) — Number of times this pipeline run has been executed - `started-at` (datetime, optional, nullable) — When the pipeline run started processing - `ended-at` (datetime, optional, nullable) — When the pipeline run finished processing - `created-at` (datetime, optional) — When the pipeline run was created - `updated-at` (datetime, optional) — When the pipeline run was last updated - `redacted-at` (datetime, optional, nullable) — When the pipeline run was redacted - `run-data` (ImporterPipelineRunAttributesRunData, optional) — Runtime data and statistics for the pipeline run ### ImporterPipelineRunRelationships - `importer-pipeline` (ImporterPipelineRunRelationshipsImporterPipeline, optional) ### ImporterPipelineRunsIncludedObjectsItemsDiscriminatorMappingImporterPipelineAttributes - `name` (string, optional) — Name of the importer pipeline - `status` (string, optional) — Current status of the importer pipeline. Possible values include `active` and `inactive`. - `run-type` (string, optional, nullable) — Type of run schedule. Possible values include `manual` and `recurring`. - `destination` (string, optional, nullable) — Destination model type for imported data - `next-run-at` (datetime, optional, nullable) — When the next run is scheduled - `created-at` (datetime, optional) — When the pipeline was created - `updated-at` (datetime, optional) — When the pipeline was last updated - `archived-at` (datetime, optional, nullable) — When the pipeline was archived - `pipeline-config` (ImporterPipelineRunsIncludedObjectsItemsDiscriminatorMappingImporterPipelineAttributesPipelineConfig, optional) — Configuration settings for the pipeline ### ImporterPipelineRunAttributesRunData Runtime data and statistics for the pipeline run - `column-names` (list of string, optional) — Names of columns being processed - `error-count` (integer, optional) — Number of errors encountered - `rows-read` (integer, optional) — Number of rows read from the source - `row-count` (integer, optional) — Total number of rows processed - `success-count` (integer, optional) — Number of rows successfully processed - `created-count` (integer, optional) — Number of new records created - `updated-count` (integer, optional) — Number of existing records updated - `estimated-total-count` (integer, optional, nullable) — Estimated total number of rows to process ### ImporterPipelineRunRelationshipsImporterPipeline - `data` (ImporterPipelineRunRelationshipsImporterPipelineData, optional) ### ImporterPipelineRunsIncludedObjectsItemsDiscriminatorMappingImporterPipelineAttributesPipelineConfig Configuration settings for the pipeline - `destination` (string, optional, nullable) — Target destination for imported data - `sync-mode` (string, optional, nullable) — How data should be synced. Possible values include `upsert`, `insert`, and `update`. - `archive-after-completion` (boolean, optional, nullable) — Whether to archive the pipeline after completion ### ImporterPipelineRunRelationshipsImporterPipelineData - `id` (string, optional) - `type` ("importer-pipeline", optional)