--- updatedAt: 2025-08-20T00:46:00.000Z agentTools: projectIndex: https://developer.authvia.com/llms.txt --- # Create Blueprint > 🔑 [scope](intro/authentication#scopes) `blueprints:create` Create a new [Blueprint](blueprints) for the specified [Account](account). This endpoint allows you to define reusable business process templates. > 📘 Info > > Blueprints provide predefined templates and workflows that can streamline your business process creation and ensure consistency across your applications. > > You can configure actions, themes, and other settings during creation or update them later. > 💡 **Tip**: Use blueprints to standardize common business processes like payment flows, customer onboarding, or document collection. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "version": "3.3", "title": "Accounts", "description": "Authvia's API empowers developers to create best in class [Customer](customers) facing solutions for their accounts. The rich catalog of [Providers](provider-product-catalog) and [Actions](acknowledgement-action) allow easy access to a rich set of features, and extensions of abilities to other systems. Using [Business Process](create-business-process) you can group various operations into a single workflow, such as document signatures, form capturing, attachments, and payments, among others. The flexibility of the API allows for an infinite combination of behaviors to streamline and enhance business operations across different channels (web/messaging) platforms.", "contact": { "name": "Support", "url": "https://support.authvia.com", "email": "support@authvia.com" } }, "servers": [ { "url": "https://api.authvia.com/v3" } ], "components": { "securitySchemes": { "bearerToken": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer", "x-default": "", "x-scopes": { "accounts:read": "Can read an [Account](get-account), the profile, contacts or the products within it.", "accounts:update": "Can read and update an [Account](get-account), the profile, contacts or the products within it." } } } }, "tags": [ { "name": "Blueprints", "description": "Establishes a wrapper around [Business Process](create-business-process) and provides as structure for other concepts like [Trigger](trigger-schema), subscriptions and reporting." }, { "name": "Webhook Types Account", "description": "Webhook events that are sent in the context of the [Account](accounts)." } ], "x-tagGroups": [ { "name": "Authentication", "tags": [ "Authentication" ] }, { "name": "Account", "tags": [ "Account" ] }, { "name": "Products", "tags": [ "Products" ] }, { "name": "Blueprints", "tags": [ "Blueprints" ] }, { "name": "Jobs", "tags": [ "Jobs" ] }, { "name": "Files", "tags": [ "Files" ] }, { "name": "Webhook Subscriptions", "tags": [ "Webhook Subscriptions" ] }, { "name": "Webhook Types Customer", "tags": [ "Webhook Types Customer" ] } ], "paths": { "/accounts/{account-id}/blueprints": { "post": { "tags": [ "Blueprints" ], "summary": "Create Blueprint", "description": "> 🔑 [scope](intro/authentication#scopes) `blueprints:create`\n\nCreate a new [Blueprint](blueprints) for the specified [Account](account). This endpoint allows you to define reusable business process templates.\n\n> 📘 Info\n> \n> Blueprints provide predefined templates and workflows that can streamline your business process creation and ensure consistency across your applications.\n> \n> You can configure actions, themes, and other settings during creation or update them later.\n\n> 💡 **Tip**: Use blueprints to standardize common business processes like payment flows, customer onboarding, or document collection.", "operationId": "create-blueprint", "security": [ { "bearerToken": [ "blueprints:create" ] } ], "parameters": [ { "name": "account-id", "in": "path", "description": "The unique identifier (AVID) of the [Account](account).", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://authvia.com/blueprint-create", "$comment": "Last updated 2024-07-09T00:00:00Z", "description": "Payload for creating a blueprint", "type": "object", "properties": { "version": { "$id": "#/properties/version", "type": "number", "examples": [ 1, 2 ], "description": "A blueprint version enables the creation of multiple iterations of the same design, supporting updates and changes over time.", "readOnly": true }, "name": { "$id": "#/properties/name", "type": "string", "minLength": 1, "examples": [ "Example Name" ], "description": "The blueprint name must be unique within an [account](account) (merchant), as its slugified version becomes the blueprint's unique identifier." }, "idSeed": { "$id": "#/properties/idSeed", "type": "string", "examples": [ "${idSeed}" ], "description": "Generates unique-deterministic id based on this value and merchant avid, if any business-process already exists with this value, it will return an error." }, "customer": { "$id": "#/properties/customer", "type": "string", "minLength": 1, "examples": [ "${ref}" ], "description": "[Dynamic variable](value-interpolation-and-functions) The unique customer reference that will receive the created business process." }, "description": { "$id": "#/properties/description", "type": "string", "minLength": 1, "examples": [ "Description of the blueprint" ], "description": "The blueprint description outlines its purpose and intent, detailing the specific business needs it aims to fulfill." }, "expiration": { "$id": "#/properties/expiration", "type": "string", "examples": [ "1d" ], "description": "[Dynamic variable](value-interpolation-and-functions) The expiration period of the business process starts from its creation time, with a default duration of 45 days, represented as 45d." }, "theme": { "$id": "#/properties/theme", "type": "object", "examples": [ { "name": "Tomato Wholesale", "color": "#743873", "logo": "mdi-apple", "banner": "https://placehold.co/1200x630/png?text=Banner", "image": "https://placehold.co/180x180/png?text=Image" } ], "description": "Customizes the visual appearance of the blueprint in the user interface. The theme object accepts the following properties:\n- name: The friendly name of the merchant shown to the customer\n- color: A hex color code for the primary theme color\n- logo: An icon identifier (e.g., Material Design Icons) for the logo\n- banner: URL to a banner image (recommended size: 1200x630px)\n- image: URL to a profile picture (recommended size: 180x180px)\nAll properties are optional and can be used to create a branded experience for the blueprint." }, "sequence": { "$id": "#/properties/sequence", "type": "number", "examples": [ 1, 2, 3 ], "description": "The sequence will affect how the blueprints are ordered and displayed within our applications." }, "agentOf": { "$id": "#/properties/agentOf", "type": "string", "examples": [ "+11234567890", "${agentOf}" ], "readOnly": true, "description": "[Dynamic variable](value-interpolation-and-functions) The agent's address provided to send messages to customers, if provided." }, "schedule": { "$id": "#/properties/schedule", "type": [ "string", "number" ], "examples": [ "${schedule:number}", 1711998550346 ], "description": "[Dynamic variable](value-interpolation-and-functions) A schedule facilitates the creation of a business process at a specified future time, provided in epoch format during real-time execution." }, "callback": { "$id": "#/properties/callback", "type": "string", "examples": [ "${callback:string}", "https://example.com/callback" ], "description": "[Dynamic variable](value-interpolation-and-functions) A callback facilitates as a webhook URL which will be invoked when the business process is created and resolved/failed." }, "actions": { "$id": "#/properties/actions", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "acknowledgement", "approval", "authentic-id", "choice", "convenience-fee", "customer-update", "instructions", "payment", "payment-method", "payment-amount-selection", "service-fee", "signature", "surcharge", "payout", "simple-value", "value-verification", "markdown", "metadata", "reminder", "tip", "line-items", "line-item-customization", "request-attachment", "upload-attachment", "threat-matrix" ], "examples": [ "payout" ], "description": "Specifies the type of business process action to be performed. Each action type represents a distinct step or operation within the business process, such as a payment or capture payment-method step. For more detail visit [action catalog](acknowledgement-action)" }, "union": { "type": "number", "examples": [ 1 ], "description": "Defines the relationship of this action with another action in terms of [union](business-processes-union). This field is used to link related actions within the business process." }, "group": { "type": "string", "examples": [ "A" ], "readOnly": true, "description": "The group of the action. One can use it to assign multiple actions into same group." }, "context": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Provides additional contextual information relevant to the business process action, with values that can either be fixed or [dynamic variable](value-interpolation-and-functions) provided during real-time execution. This may include any necessary data or parameters required for executing the action within the given context." }, "features": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Specifies additional features or attributes of the business process action, with values that can be either fixed or dynamic variables provided during real-time execution. This field may encompass both required and optional settings or configurations that specify how the action should be executed." } }, "additionalProperties": false, "examples": [ { "type": "payment", "union": 1 } ], "description": "A schema defining the representation of a business process action payload within a blueprint." } ] }, "minItems": 1 } ], "examples": [ { "type": "payout", "union": 1, "context": { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "features": { "key1": "fixed-value", "key2": "${dynamic-variable}" } }, "${dynamic-variable}:array" ], "description": "A list of business process actions in the blueprint. The order of these actions is critical for rendering messages or web experiences for customers. Each action must be defined according to the specifications in the [Action Catalog](acknowledgement-action) section." } }, "definitions": { "ActionPayload": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "acknowledgement", "approval", "authentic-id", "choice", "convenience-fee", "customer-update", "instructions", "payment", "payment-method", "payment-amount-selection", "service-fee", "signature", "surcharge", "payout", "simple-value", "value-verification", "markdown", "metadata", "reminder", "tip", "line-items", "line-item-customization", "request-attachment", "upload-attachment", "threat-matrix" ], "examples": [ "payout" ], "description": "Specifies the type of business process action to be performed. Each action type represents a distinct step or operation within the business process, such as a payment or capture payment-method step. For more detail visit [action catalog](acknowledgement-action)" }, "union": { "type": "number", "examples": [ 1 ], "description": "Defines the relationship of this action with another action in terms of [union](business-processes-union). This field is used to link related actions within the business process." }, "group": { "type": "string", "examples": [ "A" ], "readOnly": true, "description": "The group of the action. One can use it to assign multiple actions into same group." }, "context": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Provides additional contextual information relevant to the business process action, with values that can either be fixed or [dynamic variable](value-interpolation-and-functions) provided during real-time execution. This may include any necessary data or parameters required for executing the action within the given context." }, "features": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Specifies additional features or attributes of the business process action, with values that can be either fixed or dynamic variables provided during real-time execution. This field may encompass both required and optional settings or configurations that specify how the action should be executed." } }, "additionalProperties": false, "examples": [ { "type": "payment", "union": 1 } ], "description": "A schema defining the representation of a business process action payload within a blueprint." } }, "required": [ "name", "description", "customer", "actions" ], "additionalProperties": false }, "examples": { "CreateBlueprint": { "summary": "Create Blueprint Example", "value": { "name": "Payment Flow", "description": "Standard payment processing flow", "customer": "${ref}", "actions": [ { "type": "payment", "context": { "amount": "${amount:number}" }, "features": { "description": "Payment for services" } }, { "type": "signature", "features": { "title": "Terms and Conditions", "content": "Please review and sign the terms..." } } ] } } } } } }, "responses": { "201": { "description": "Successfully created blueprint. Returns the complete blueprint details including actions and configuration.", "content": { "application/json": { "examples": { "SuccessfulResponse": { "value": { "id": "00000000-0000-0000-0000-000000000000", "name": "Payment Flow", "description": "Standard payment processing flow", "status": "active", "createdOn": "2024-01-01T00:00:00Z", "customer": "${ref}", "actions": [ { "id": "00000000-0000-0000-0000-000000000000", "type": "payment", "context": { "amount": "${amount:number}" }, "features": { "description": "Payment for services" } } ] } } }, "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://authvia.com/blueprint", "$comment": "Last updated 2024-07-09T00:00:00Z", "description": "Schema for representing a blueprint", "type": "object", "properties": { "id": { "$id": "#/properties/id", "type": "string", "examples": [ "example-name" ], "description": "The unique identifier of the blueprint or the slugified version of blueprint name" }, "merchant": { "$id": "#/properties/merchant", "type": "string", "description": "The unique identifier (AVID) of the merchant's account.", "examples": [ "00000000-0000-0000-0000-000000000000" ] }, "partner": { "$id": "#/properties/partner", "type": "string", "description": "The unique identifier of the partner account to which the merchant belongs.", "examples": [ "example-name" ] }, "version": { "$id": "#/properties/version", "type": "number", "examples": [ 1, 2 ], "description": "A blueprint version enables the creation of multiple iterations of the same design, supporting updates and changes over time.", "writeOnly": true }, "name": { "$id": "#/properties/name", "type": "string", "examples": [ "Example Name" ], "description": "The blueprint name must be unique within an [account](account) (merchant), as its slugified version becomes the blueprint's unique identifier." }, "customer": { "$id": "#/properties/customer", "type": "string", "examples": [ "${ref}" ], "description": "[Dynamic variable](value-interpolation-and-functions) The unique customer reference that will receive the created business process." }, "description": { "$id": "#/properties/description", "type": "string", "examples": [ "Description of the blueprint" ], "description": "The blueprint description outlines its purpose and intent, detailing the specific business needs it aims to fulfill." }, "expiration": { "$id": "#/properties/expiration", "type": "string", "examples": [ "1d" ], "description": "[Dynamic variable](value-interpolation-and-functions) The expiration period of the business process starts from its creation time, with a default duration of 45 days, represented as 45d." }, "theme": { "$id": "#/properties/theme", "type": "object", "examples": [ { "key1": "value", "key2": "value" } ], "description": "Theme settings for the blueprint allow for the addition of extra functionality to its visual representation and user interface." }, "sequence": { "$id": "#/properties/sequence", "type": "number", "examples": [ 1, 2, 3 ], "description": "The sequence will affect how the blueprints are ordered and displayed within our applications." }, "agentOf": { "$id": "#/properties/agentOf", "type": "string", "examples": [ "+11234567890", "${agentOf}" ], "writeOnly": true, "description": "[Dynamic variable](value-interpolation-and-functions) The agent's address provided to send messages to customers, if provided." }, "schedule": { "$id": "#/properties/schedule", "type": [ "string", "number" ], "examples": [ "${schedule:number}", 1711998550346 ], "description": "[Dynamic variable](value-interpolation-and-functions) A schedule facilitates the creation of a business process at a specified future time, provided in epoch format during real-time execution." }, "callback": { "$id": "#/properties/callback", "type": "string", "examples": [ "${callback:string}", "https://example.com/callback" ], "description": "[Dynamic variable](value-interpolation-and-functions) A callback facilitates as a webhook URL which will be invoked when the business process is created and resolved/failed." }, "idSeed": { "$id": "#/properties/idSeed", "type": "string", "examples": [ "${idSeed}" ], "description": "Generates unique-deterministic id based on this value and merchant avid, if any business-process already exists with this value, it will return an error." }, "actions": { "$id": "#/properties/actions", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "acknowledgement", "approval", "choice", "convenience-fee", "instructions", "payment", "payment-method", "payment-amount-selection", "service-fee", "signature", "surcharge", "payout", "simple-value", "value-verification", "markdown", "tip", "line-items", "line-item-customization", "authentic-id" ], "examples": [ "payout" ], "description": "Specifies the type of business process action to be performed. Each action type represents a distinct step or operation within the business process, such as a payment or capture payment-method step. For more detail visit [action catalog](acknowledgement-action)" }, "union": { "type": "number", "examples": [ 1 ], "description": "Defines the relationship of this action with another action in terms of [union](business-processes-union). This field is used to link related actions within the business process." }, "group": { "type": "string", "examples": [ "A" ], "writeOnly": true, "description": "The group of the action. One can use it to assign multiple actions into same group." }, "context": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Provides additional contextual information relevant to the business process action, with values that can either be fixed or [dynamic variable](value-interpolation-and-functions) provided during real-time execution. This may include any necessary data or parameters required for executing the action within the given context." }, "features": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Specifies additional features or attributes of the business process action, with values that can be either fixed or dynamic variables provided during real-time execution. This field may encompass both required and optional settings or configurations that specify how the action should be executed." } }, "examples": [ { "type": "payment", "union": 1 } ], "description": "A schema defining the representation of a business process action payload within a blueprint." } ] }, "minItems": 1 } ], "examples": [ { "type": "payout", "union": 1, "context": { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "features": { "key1": "fixed-value", "key2": "${dynamic-variable}" } }, "${dynamic-variable}:array" ], "description": "A list of business process actions in the blueprint. The order of these actions is critical for rendering messages or web experiences for customers. Each action must be defined according to the specifications in the [Action Catalog](acknowledgement-action) section." }, "createdOn": { "$id": "#/properties/createdOn", "type": "string", "description": "The date when the blueprint was created.", "examples": [ "1970-01-01T00:00:00Z" ] }, "updatedOn": { "$id": "#/properties/updatedOn", "type": "string", "description": "The date when the blueprint was last updated.", "examples": [ "1970-01-01T00:00:00Z" ] } }, "definitions": { "ActionPayload": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "acknowledgement", "approval", "choice", "convenience-fee", "instructions", "payment", "payment-method", "payment-amount-selection", "service-fee", "signature", "surcharge", "payout", "simple-value", "value-verification", "markdown", "tip", "line-items", "line-item-customization", "authentic-id" ], "examples": [ "payout" ], "description": "Specifies the type of business process action to be performed. Each action type represents a distinct step or operation within the business process, such as a payment or capture payment-method step. For more detail visit [action catalog](acknowledgement-action)" }, "union": { "type": "number", "examples": [ 1 ], "description": "Defines the relationship of this action with another action in terms of [union](business-processes-union). This field is used to link related actions within the business process." }, "group": { "type": "string", "examples": [ "A" ], "writeOnly": true, "description": "The group of the action. One can use it to assign multiple actions into same group." }, "context": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Provides additional contextual information relevant to the business process action, with values that can either be fixed or [dynamic variable](value-interpolation-and-functions) provided during real-time execution. This may include any necessary data or parameters required for executing the action within the given context." }, "features": { "anyOf": [ { "type": "string" }, { "type": "object" } ], "examples": [ { "key1": "fixed-value", "key2": "${dynamic-variable}" }, "${dynamic-variable}:object" ], "description": "Specifies additional features or attributes of the business process action, with values that can be either fixed or dynamic variables provided during real-time execution. This field may encompass both required and optional settings or configurations that specify how the action should be executed." } }, "examples": [ { "type": "payment", "union": 1 } ], "description": "A schema defining the representation of a business process action payload within a blueprint." } } } } } }, "400": { "description": "Bad Request - The request cannot be processed due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "content": { "application/json": { "examples": { "badRequestExample": { "summary": "Bad Request example", "value": { "path": "/v3/merchants/a530d3e3-151a-47d6-ad60-f9009bb686b9/customers/Customer_5079772987930815", "action": "PATCH", "errors": [ { "attribute": "email", "message": "Invalid email format", "data": { "value": [ { "type": "string", "value": "test@test" } ], "type": "object" } } ] } } }, "schema": { "title": "400 Bad Request Response", "type": "object", "required": [ "path", "action", "errors" ], "properties": { "path": { "type": "string", "description": "The API path where the bad request occurred.", "example": "/v3/merchants/a530d3e3-151a-47d6-ad60-f9009bb686b9/customers/Customer_5079772987930815" }, "action": { "type": "string", "description": "The HTTP method (e.g., GET, POST, PATCH) associated with the bad request.", "example": "PATCH" }, "errors": { "type": "array", "description": "A list of error details indicating why the request was considered a bad request.", "items": { "type": "object", "required": [ "attribute", "message", "data" ], "properties": { "attribute": { "type": "string", "description": "The JSON pointer to the field in the request that caused the bad request.", "example": "addresses.0/value" }, "message": { "type": "string", "description": "A human-readable message explaining why the request was bad.", "example": "Invalid email" }, "data": { "type": "object", "required": [ "value", "type" ], "properties": { "value": { "type": "array", "items": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "description": "The expected data type of the field that was violated.", "example": "email" }, "value": { "type": "string", "description": "The invalid value that was provided in the request.", "example": "test@test.com" } } } }, "type": { "type": "string", "description": "The data structure type that contains the validation error.", "example": "object" } } } } } } } } } } }, "401": { "description": "The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Unauthorized\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Unauthorized" } } } } } }, "403": { "description": "The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort. This status is similar to 401, but in this case, re-authenticating will make no difference. The access is permanently forbidden and tied to the application logic, such as insufficient rights to a resource.", "content": { "application/json": { "examples": { "UnauthorizedAccess": { "summary": "Unauthorized Access Example", "value": { "message": "User is not authorized to access this resource" } } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "User is not authorized to access this resource" } } } } } }, "404": { "description": "The requested resource was not found. This response indicates that the server can't find the requested resource. In the context of an API, this can mean that the endpoint is valid but the resource itself does not exist. For developers, this typically means that the URL or its content (such as specific ID) does not exist. Check the URL and the resource identifier.", "content": { "application/json": { "examples": { "EmptyResponse": { "summary": "Empty or Undefined Response", "value": {} } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "webhooks": { "jobs.create": { "post": { "tags": [ "Webhook Types Account" ], "summary": "Job Created", "operationId": "job-create-webhook", "description": "> 📬 Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `jobs.create`\n\nReceive real-time notifications when new [Jobs](jobs) are created in your [Account](account). This webhook enables you to synchronize your systems with job creation events.\n\n> 📘 Info\n> \n> The webhook payload contains the job ID and basic details. Use the [Get Job](get-account-job) endpoint to retrieve complete job information.\n\n> ⚠️ Warning\n> \n> Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive).\n\nCommon use cases include updating your job management system, triggering notifications, or logging job events in your analytics platform.", "security": [ { "bearerToken": [ "jobs:read", "subscriptions:create" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://authvia.com/webhook/account-job", "$comment": "Last updated 2024-10-25T00:00:00Z", "description": "Schema for representing a account job", "type": "object", "properties": { "id": { "$id": "#/properties/id", "type": "string", "description": "The unique identifier of the job", "examples": [ "0c7832c1-aece-5dc1-8bfb-c039d2411cb9" ] }, "merchant": { "$id": "#/properties/merchant", "type": "string", "description": "The unique identifier (AVID) of the merchant's account.", "examples": [ "9cd8e0ec-6ae5-431a-b17a-54f2c4f78148" ] }, "fileName": { "$id": "#/properties/fileName", "type": "string", "description": "The name of the uploaded csv file.", "examples": [ "batch-customer-creation.csv" ] }, "lines": { "$id": "#/properties/lines", "type": "integer", "description": "The total number of lines in the file.", "examples": [ 2 ] }, "inProgressLines": { "$id": "#/properties/inProgressLines", "type": "integer", "description": "The number of lines currently in progress.", "examples": [ 2 ] }, "successfulLines": { "$id": "#/properties/successfulLines", "type": "integer", "description": "The number of successful lines processed.", "examples": [ 0 ] }, "invalidLines": { "$id": "#/properties/invalidLines", "type": "integer", "description": "The number of invalid lines found in the file.", "examples": [ 0 ] }, "failedLines": { "$id": "#/properties/failedLines", "type": "integer", "description": "The number of lines that failed during processing.", "examples": [ 0 ] }, "status": { "$id": "#/properties/status", "type": "string", "enum": [ "accepted", "ingesting", "processing", "successful", "partial-completed", "invalid" ], "description": "The current processing status of the uploaded csv file.", "examples": [ "processing" ] }, "completedOn": { "$id": "#/properties/completedOn", "type": "string", "format": "date-time", "description": "The timestamp when the processing of the file was completed.", "examples": [ "2024-10-18T07:39:26.428Z" ] }, "createdOn": { "$id": "#/properties/createdOn", "type": "string", "description": "The timestamp when the job was created.", "examples": [ "2024-10-18T06:49:19.229Z" ] }, "updatedOn": { "$id": "#/properties/updatedOn", "type": "string", "description": "The timestamp when the job was last updated.", "examples": [ "2024-10-18T07:39:26.428Z" ] } } }, "examples": { "JobCreated": { "summary": "Job Created", "value": { "id": "00000000-0000-0000-0000-000000000000", "merchantId": "AVID0000-0000-0000-0000-000000000000", "type": "bulk-upload", "status": "ingesting", "createdOn": "2024-01-01T00:00:00Z" } } } } } }, "responses": { "200": { "description": "> Your system should return a 2xx status to indicate that the data was published successfully. Other statuses will be considered a failure and we will retry later. See the [redrive](subscriptions-redrive) page for more details." } } } }, "jobs.update": { "post": { "tags": [ "Webhook Types Account" ], "summary": "Job Updated", "operationId": "job-updated-webhook", "description": "> 📬 Your system will receive this payload when you create a [Subscription](webhook-subscriptions) with type `jobs.update`\n\nReceive real-time notifications when [Jobs](jobs) are updated in your [Account](account). This webhook enables you to synchronize your systems with job status changes.\n\n> 📘 Info\n> \n> The webhook payload contains the job ID and updated details. Use the [Get Job](get-account-job) endpoint to retrieve complete job information.\n\n> ⚠️ Warning\n> \n> Your webhook endpoint must return a 2xx status code within 30 seconds to confirm receipt. Failed deliveries will be retried according to the [redrive policy](subscriptions-redrive).\n\nCommon use cases include updating your job management system, triggering notifications, or logging job status changes in your analytics platform.", "security": [ { "bearerToken": [ "jobs:read", "subscriptions:create" ] } ], "requestBody": { "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://authvia.com/webhook/account-job", "$comment": "Last updated 2024-10-25T00:00:00Z", "description": "Schema for representing a account job", "type": "object", "properties": { "id": { "$id": "#/properties/id", "type": "string", "description": "The unique identifier of the job", "examples": [ "0c7832c1-aece-5dc1-8bfb-c039d2411cb9" ] }, "merchant": { "$id": "#/properties/merchant", "type": "string", "description": "The unique identifier (AVID) of the merchant's account.", "examples": [ "9cd8e0ec-6ae5-431a-b17a-54f2c4f78148" ] }, "fileName": { "$id": "#/properties/fileName", "type": "string", "description": "The name of the uploaded csv file.", "examples": [ "batch-customer-creation.csv" ] }, "lines": { "$id": "#/properties/lines", "type": "integer", "description": "The total number of lines in the file.", "examples": [ 2 ] }, "inProgressLines": { "$id": "#/properties/inProgressLines", "type": "integer", "description": "The number of lines currently in progress.", "examples": [ 2 ] }, "successfulLines": { "$id": "#/properties/successfulLines", "type": "integer", "description": "The number of successful lines processed.", "examples": [ 0 ] }, "invalidLines": { "$id": "#/properties/invalidLines", "type": "integer", "description": "The number of invalid lines found in the file.", "examples": [ 0 ] }, "failedLines": { "$id": "#/properties/failedLines", "type": "integer", "description": "The number of lines that failed during processing.", "examples": [ 0 ] }, "status": { "$id": "#/properties/status", "type": "string", "enum": [ "accepted", "ingesting", "processing", "successful", "partial-completed", "invalid" ], "description": "The current processing status of the uploaded csv file.", "examples": [ "processing" ] }, "completedOn": { "$id": "#/properties/completedOn", "type": "string", "format": "date-time", "description": "The timestamp when the processing of the file was completed.", "examples": [ "2024-10-18T07:39:26.428Z" ] }, "createdOn": { "$id": "#/properties/createdOn", "type": "string", "description": "The timestamp when the job was created.", "examples": [ "2024-10-18T06:49:19.229Z" ] }, "updatedOn": { "$id": "#/properties/updatedOn", "type": "string", "description": "The timestamp when the job was last updated.", "examples": [ "2024-10-18T07:39:26.428Z" ] } } }, "examples": { "JobUpdated": { "summary": "Job Updated", "value": { "id": "00000000-0000-0000-0000-000000000000", "merchantId": "AVID0000-0000-0000-0000-000000000000", "type": "bulk-upload", "status": "completed", "updatedOn": "2024-01-01T00:00:00Z" } } } } } }, "responses": { "200": { "description": "> Your system should return a 2xx status to indicate that the data was published successfully. Other statuses will be considered a failure and we will retry later. See the [redrive](subscriptions-redrive) page for more details." } } } } }, "x-readme": { "headers": [ { "key": "Content-Type", "value": "application/json" } ], "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true }, "x-readme-fauxas": true } ```