# Get aicreditsusage Source: https://docs.alumio.com/api-reference/ai/get-aicreditsusage /schema.json get /ai/credits/usage Get the AI credit usage for the current month and the number of allowed credits. # Get application capabilities Source: https://docs.alumio.com/api-reference/application/get-application-capabilities /schema.json get /application/capabilities Retrieves the application's capability flags as an object mapping each capability name to a boolean indicating whether it is enabled. # Export current space audit trail Source: https://docs.alumio.com/api-reference/audittrail/export-current-space-audit-trail /schema.json post /audit_trail/current_space/export Exports the audit trail entries for the current space. Accepts an optional filter in the form-encoded request body to narrow down which entries are included in the export. # Get current space audit trail item Source: https://docs.alumio.com/api-reference/audittrail/get-current-space-audit-trail-item /schema.json get /audit_trail/current_space/item/{identifier} Retrieves a single audit trail item from the current space, identified by the entry identifier supplied in the path. Returns the matching audit trail item, or an error response if it cannot be found. # Get current space audit trail list Source: https://docs.alumio.com/api-reference/audittrail/get-current-space-audit-trail-list /schema.json get /audit_trail/current_space/list Retrieves the list of audit trail entries recorded for the current space, returning the matching items together with pagination metadata. Accepts an optional filter query parameter to narrow the results by search criteria. # Kill a queued or running process Source: https://docs.alumio.com/api-reference/background/kill-a-queued-or-running-process /schema.json post /queue/kill/{identifier} Kills the queued or running background process matching the identifier path parameter, terminating it immediately. Returns a message describing the outcome. # Stop a running process Source: https://docs.alumio.com/api-reference/background/stop-a-running-process /schema.json post /queue/stop/{identifier} Stops the running background process matching the identifier path parameter, signalling it to halt gracefully. Returns a message describing the outcome. # Bulk delete object configurations Source: https://docs.alumio.com/api-reference/di/bulk-delete-object-configurations /schema.json delete /di/configurations/{type}/bulk/delete Deletes all object configurations of the given type that match the filter in the request body. Returns the number of configurations that were deleted. # Bulk export object configurations Source: https://docs.alumio.com/api-reference/di/bulk-export-object-configurations /schema.json post /di/export/bulk Exports a selected set of object configurations identified by their type and identifier in the request body, optionally scoped with a client time. Returns the exported configurations for the requested objects. # Create an object configuration Source: https://docs.alumio.com/api-reference/di/create-an-object-configuration /schema.json post /di/configurations Creates a new object configuration from the type, name, and object payload in the request body. Returns the created configuration on success. # Create an object relation Source: https://docs.alumio.com/api-reference/di/create-an-object-relation /schema.json post /di/relations/{type}/{owner} Creates a new object relation for the given type and owner from the relation supplied in the request body. Returns the created relation. # Delete an object configuration Source: https://docs.alumio.com/api-reference/di/delete-an-object-configuration /schema.json delete /di/configurations/{type}/{identifier} Deletes the object configuration identified by the type and identifier path parameters. Returns a message confirming the deletion. # Delete an object relation Source: https://docs.alumio.com/api-reference/di/delete-an-object-relation /schema.json delete /di/relations/{type}/{owner}/{identifier} Deletes the object relation identified by its type, owner, and identifier. Returns a confirmation message on success. # Export object configurations by type Source: https://docs.alumio.com/api-reference/di/export-object-configurations-by-type /schema.json post /di/export/{type} Exports the configurations of the object type given in the path, optionally filtered to the identifiers supplied in the request body. Returns the exported configurations for the matching objects. # Get a list of labels Source: https://docs.alumio.com/api-reference/di/get-a-list-of-labels /schema.json get /di/labels/list Retrieves all labels defined in the system. Returns a list of labels along with action metadata. # Get an object configuration Source: https://docs.alumio.com/api-reference/di/get-an-object-configuration /schema.json get /di/configurations/{type}/{identifier} Retrieves a single object configuration identified by the type and identifier path parameters. Returns the matching configuration. # Get an object relation Source: https://docs.alumio.com/api-reference/di/get-an-object-relation /schema.json get /di/relations/{type}/{owner}/{identifier} Retrieves a single object relation identified by its type, owner, and identifier. Returns the matching relation. # Get object configurations Source: https://docs.alumio.com/api-reference/di/get-object-configurations /schema.json get /di/configurations Retrieves the list of available object configurations, optionally narrowed down with the filter query parameter. Returns the matching configurations together with pagination metadata. # Get object relations Source: https://docs.alumio.com/api-reference/di/get-object-relations /schema.json get /di/relations/{type}/{owner} Retrieves the list of object relations for the given type and owner. Accepts an optional filter query parameter to apply search criteria, and returns the matching relations along with metadata. # Get stored object configurations Source: https://docs.alumio.com/api-reference/di/get-stored-object-configurations /schema.json get /di/stored-configurations Retrieves the list of object configurations that are persisted in storage, optionally narrowed down with the filter query parameter. Returns the matching configurations together with pagination metadata. # Get the history of an object Source: https://docs.alumio.com/api-reference/di/get-the-history-of-an-object /schema.json get /di/configurations/{type}/{identifier}/history Retrieves the list of historical states recorded for the configuration identified by the given type and identifier. Accepts an optional filter query parameter to narrow the returned history entries by search criteria. # Import object configurations Source: https://docs.alumio.com/api-reference/di/import-object-configurations /schema.json post /di/import Imports object configurations supplied as JSON, NDJSON, or uploaded files, and returns a result detailing per-object decisions, actions, relationships, and any validation violations. Set the dry-run query parameter to only validate and check for existing configurations without persisting, or validate-variables to additionally validate variables. # List configuration relations Source: https://docs.alumio.com/api-reference/di/list-configuration-relations /schema.json get /di/list/nodes/{type}/{identifier} Resolves the dependency relations for a single configuration identified by its type and identifier path parameters, returning the resolved nodes with their relationships. Use the optional "direction" query parameter to control how relations are traversed (down, up, both, or recursive). # List configuration relations for multiple configurations Source: https://docs.alumio.com/api-reference/di/list-configuration-relations-for-multiple-configurations /schema.json post /di/list/nodes/bulk Resolves dependency relations for multiple configurations supplied as a list of type and identifier pairs in the request body, returning each resolved node with its relationships. Use the optional "direction" query parameter to control how relations are traversed (down, up, both, or recursive). # List configuration usages Source: https://docs.alumio.com/api-reference/di/list-configuration-usages /schema.json get /di/list/usages/{type}/{identifier} Retrieves the usages of the dependency injection configuration identified by the given type and identifier path parameters. Returns a list of usages, each describing the property path, type, and specification where the configuration is referenced. # List dependants Source: https://docs.alumio.com/api-reference/di/list-dependants /schema.json get /di/list/dependants Retrieves the configuration dependants, returning each dependant with its type, identifier, and the usages that reference it. Accepts an optional filter query parameter to narrow the results by search criteria. # List object configurations Source: https://docs.alumio.com/api-reference/di/list-object-configurations /schema.json get /di/list/{type}/configurations Retrieves the configured objects for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria. # List object configurations and prototypes Source: https://docs.alumio.com/api-reference/di/list-object-configurations-and-prototypes /schema.json get /di/list/{type} Retrieves both the configured objects and the available prototypes for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria. # List object prototypes Source: https://docs.alumio.com/api-reference/di/list-object-prototypes /schema.json get /di/list/{type}/prototypes Retrieves the available object prototypes for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria. # List platforms Source: https://docs.alumio.com/api-reference/di/list-platforms /schema.json get /di/platforms Retrieves a list of available data integration platforms, each including its identifier, name, categories, vendor, logo, editions, extensions, and APIs. Accepts an optional filter query parameter to narrow results by search criteria. # Patch an object configuration Source: https://docs.alumio.com/api-reference/di/patch-an-object-configuration /schema.json patch /di/configurations Partially updates an existing object configuration, identified by the type and identifier in the request body, applying only the supplied fields. Returns the updated configuration. # Restore a configuration to a previous state Source: https://docs.alumio.com/api-reference/di/restore-a-configuration-to-a-previous-state /schema.json put /di/configurations/restore/{type}/{identifier} Restores the configuration identified by the given type and identifier to a previous historical state, selected by the ulid supplied in the request body. Returns the restored configuration object. # Set labels of a configuration Source: https://docs.alumio.com/api-reference/di/set-labels-of-a-configuration /schema.json put /di/labels/{type}/{identifier} Replaces the labels assigned to the configuration identified by the given type and identifier with the labels provided in the request body. Returns the updated list of labels along with action metadata. # Test a non-stored object configuration Source: https://docs.alumio.com/api-reference/di/test-a-non-stored-object-configuration /schema.json post /di/configurations/{type}/test Tests an object configuration of the given type without persisting it, using the specification and test data supplied in the request body. Returns the test result for the evaluated object. # Test an object configuration Source: https://docs.alumio.com/api-reference/di/test-an-object-configuration /schema.json get /di/configurations/{type}/{identifier}/test Tests the stored object configuration identified by the type and identifier path parameters and returns the test result for the evaluated object. # Toggle favorite status Source: https://docs.alumio.com/api-reference/di/toggle-favorite-status /schema.json put /di-favorite/toggle Toggles the favourite status of a configuration identified by its type and identifier, marking it as a favourite if it is not already one and removing the favourite otherwise. Returns the resulting favourite item reflecting the new status. # Update an object configuration Source: https://docs.alumio.com/api-reference/di/update-an-object-configuration /schema.json put /di/configurations Replaces an existing object configuration, identified by the type and identifier in the request body, with the supplied values. Returns the updated configuration. # Update an object configuration status Source: https://docs.alumio.com/api-reference/di/update-an-object-configuration-status /schema.json put /di/configurations/{type}/{identifier}/status Updates the enabled or disabled status of the object configuration identified by the type and identifier path parameters, using the disabled flag in the request body. Returns the updated configuration. # Update an object relation Source: https://docs.alumio.com/api-reference/di/update-an-object-relation /schema.json put /di/relations/{type}/{owner}/{identifier} Updates the object relation identified by its type, owner, and identifier with the data supplied in the request body. Returns the updated relation. # Validate configured object configurations Source: https://docs.alumio.com/api-reference/di/validate-configured-object-configurations /schema.json post /di/configurations/validate/configured Validates the configured object configurations and returns a DiValidationResult listing any validation violations found. Use the optional type query parameter to restrict validation to a single type identifier. # Validate registered object configurations Source: https://docs.alumio.com/api-reference/di/validate-registered-object-configurations /schema.json post /di/configurations/validate/registered Validates the registered object configurations and returns a DiValidationResult; responds with status 400 when invalid configurations are found. Use the optional type query parameter to restrict validation to a single type identifier. # Bulk export all object configurations Source: https://docs.alumio.com/api-reference/diexport/bulk-export-all-object-configurations /schema.json post /di/export_all/bulk Exports every object configuration in the environment as a single bulk export. Returns the exported configurations for all object types without requiring a selection. # Create environment variable Source: https://docs.alumio.com/api-reference/environment/create-environment-variable /schema.json post /environment/variables Creates a new environment variable from the supplied name and value, optionally marked as encrypted, and returns the created variable. # Delete environment variable Source: https://docs.alumio.com/api-reference/environment/delete-environment-variable /schema.json delete /environment/variables/{name} Deletes the environment variable identified by its name in the path and returns a confirmation message. # Get environment variable Source: https://docs.alumio.com/api-reference/environment/get-environment-variable /schema.json get /environment/variables/{name} Retrieves a single environment variable identified by its name in the path. # Get variable usage Source: https://docs.alumio.com/api-reference/environment/get-variable-usage /schema.json get /environment/variables/{variable}/usage Retrieves the configurations that reference the specified environment variable. Returns a list of usage entries, each identifying the configuration by its type, identifier, and name. # List candidate environment variables Source: https://docs.alumio.com/api-reference/environment/list-candidate-environment-variables /schema.json get /environment/candidates Retrieves candidate environment variables detected across the system, each returned with the locations where it is referenced as a list of matches describing the match type, metadata, and payload. Use this to discover values that could be promoted to environment variables. # List environment variables Source: https://docs.alumio.com/api-reference/environment/list-environment-variables /schema.json get /environment/variables Retrieves the collection of environment variables. Accepts an optional filter query parameter to apply search criteria. # Update environment variable Source: https://docs.alumio.com/api-reference/environment/update-environment-variable /schema.json put /environment/variables/{name} Updates the environment variable identified by its name, modifying its description, value, or encrypted flag, and returns the updated variable. For encrypted variables the value may be left blank to retain the current value. # Get environment information Source: https://docs.alumio.com/api-reference/info/get-environment-information /schema.json get /info/environment Retrieves information about the current environment, including data engine settings such as the memory limit and number of workers, along with usage metrics for filesystem and database size. # Get subscription details Source: https://docs.alumio.com/api-reference/info/get-subscription-details /schema.json get /info/subscription Retrieves details about the current Alumio subscription, including the environment and subscription identifiers, edition, version, queue status, related URLs, support contact details, and the list of associated environments. # Retrieve application information Source: https://docs.alumio.com/api-reference/info/retrieve-application-information /schema.json get /info/server Retrieves general server information about the application, including the server IP address, the OAuth2 redirect URL, and the API base URL. # Retrieve support information Source: https://docs.alumio.com/api-reference/info/retrieve-support-information /schema.json get /info/support Retrieves support-related information, including the support portal URL and the login help URL. # Delete a token Source: https://docs.alumio.com/api-reference/jwt/delete-a-token /schema.json delete /tokens/{identifier} Deletes the JWT token identified by the identifier path parameter. Returns a confirmation message. # Generate a new token Source: https://docs.alumio.com/api-reference/jwt/generate-a-new-token /schema.json post /tokens Generates a new JWT token from the supplied name and optional description. Returns the generated access token together with its identifier. # Get a token Source: https://docs.alumio.com/api-reference/jwt/get-a-token /schema.json get /tokens/{identifier} Retrieves a single JWT token identified by the identifier path parameter. Returns the token's metadata such as name, description, creation details, and last used timestamp. # List tokens Source: https://docs.alumio.com/api-reference/jwt/list-tokens /schema.json get /tokens Retrieves the list of JWT token identifiers along with their metadata. Accepts an optional filter query parameter to apply search criteria. # Update a token Source: https://docs.alumio.com/api-reference/jwt/update-a-token /schema.json patch /tokens/{identifier} Updates the name and description of the JWT token identified by the identifier path parameter. Returns the updated token. # Count logs Source: https://docs.alumio.com/api-reference/log/count-logs /schema.json post /logs/count Counts the log entries in Elasticsearch that match the supplied query and returns the total number of hits. The target index is selected with the optional index query parameter, which defaults to filebeat-*. # Export Elasticsearch by ID Source: https://docs.alumio.com/api-reference/log/export-elasticsearch-by-id /schema.json get /elasticsearch/export/{id} Exports the Elasticsearch log entry identified by the given message id. Returns the matching log data for that message. # Export Elasticsearch logs in bulk Source: https://docs.alumio.com/api-reference/log/export-elasticsearch-logs-in-bulk /schema.json post /logs/export/bulk Exports the Elasticsearch log entries identified by the given message ids as a newline-delimited JSON (application/x-ndjson) file. The body is form encoded, so a browser can stream the download itself. IDs that cannot be found are omitted from the result. Optionally accepts an index override, defaulting to filebeat-*, and a clientTime used to name the file in the caller's timezone. # Search logs Source: https://docs.alumio.com/api-reference/log/search-logs /schema.json post /logs/search Searches log entries in Elasticsearch using the supplied query and returns the matching documents. The target index is selected with the optional index query parameter, which defaults to filebeat-*. # Get maintenance window logs Source: https://docs.alumio.com/api-reference/maintenancewindow/get-maintenance-window-logs /schema.json get /maintenance_window/logs Retrieves the list of maintenance window log records, each describing a maintenance window's identifier, start and end dates, and timezone. Accepts an optional filter query parameter to narrow the results by search criteria. # Get notification usage info Source: https://docs.alumio.com/api-reference/notifier/get-notification-usage-info /schema.json get /notifier/info Retrieves notification usage statistics broken down per channel, returning the number of notifications sent and the credits consumed for each channel. # Get OAuth token key Source: https://docs.alumio.com/api-reference/oauth/get-oauth-token-key /schema.json get /oauth/redirect Initiates the OAuth flow for the specified provider and redirects to the provider's authorization endpoint to obtain a token key. Accepts the current key and a callback id used to correlate the returned authorization data. # Handle OAuth1 callback Source: https://docs.alumio.com/api-reference/oauth/handle-oauth1-callback /schema.json get /oauth1/callback Handles the OAuth1 callback by validating the oauth_token and oauth_verifier query parameters returned by the provider to complete the authorization flow. Typically responds with a redirect once the callback is processed. # Initialize OAuth1 token request Source: https://docs.alumio.com/api-reference/oauth/initialize-oauth1-token-request /schema.json get /oauth1/initialize/token Starts the OAuth1 authorization flow for the given provider, using the supplied provider specification, key, and callbackId to track the request. Typically responds with a redirect to the provider's authorization URL. # Get a list of queued processes Source: https://docs.alumio.com/api-reference/queue/get-a-list-of-queued-processes /schema.json get /queue/process/list Retrieves the list of queue processes along with action metadata. Accepts an optional filter query parameter to narrow the results by search criteria. # Get a single job Source: https://docs.alumio.com/api-reference/queue/get-a-single-job /schema.json get /queue/job/{job}/view Retrieves the details of a single queue job identified by the job path parameter. Returns the job's queue process information. # Get a single process Source: https://docs.alumio.com/api-reference/queue/get-a-single-process /schema.json get /queue/process/{process}/view Retrieves the details of a single queue process identified by the process path parameter. Returns the process log including its status, priority, command type, and timing information. # Kill jobs in bulk Source: https://docs.alumio.com/api-reference/queue/kill-jobs-in-bulk /schema.json post /queue/jobs/kill/bulk Kills multiple jobs matching the filter provided in the request body, terminating them immediately. Returns a message and the number of jobs that were scheduled for killing. # Publish a job in the queue Source: https://docs.alumio.com/api-reference/queue/publish-a-job-in-the-queue /schema.json post /queue/publish Publishes a job onto the queue from the request body, specifying its target queue, priority, and the commands to run. Returns a confirmation message and the process identifier of the scheduled job. # Skip jobs in bulk Source: https://docs.alumio.com/api-reference/queue/skip-jobs-in-bulk /schema.json post /queue/jobs/skip/bulk Skips multiple queued jobs matching the filter provided in the request body. Returns a message and the number of jobs that were skipped. # Stop jobs in bulk Source: https://docs.alumio.com/api-reference/queue/stop-jobs-in-bulk /schema.json post /queue/jobs/stop/bulk Stops multiple jobs matching the filter provided in the request body, signalling them to halt gracefully. Returns a message and the number of jobs that were scheduled for stopping. # Get routes across all spaces Source: https://docs.alumio.com/api-reference/reporting/get-routes-across-all-spaces /schema.json get /reporting/all_routes Retrieves all routes from every space, returning each route's type, identifier, space, name, disabled status, and timestamps. Accepts an optional filter query parameter to narrow the results by search criteria. # Get stats about routes and tasks Source: https://docs.alumio.com/api-reference/reporting/get-stats-about-routes-and-tasks /schema.json get /reporting/routes Retrieves task processing statistics aggregated per route, returning counts of new, processing, skipped, finished, and failed tasks for each route. Supports optional filtering by a date range using the from and to query parameters and by a specific route identifier. # Get the statistics of routes Source: https://docs.alumio.com/api-reference/reporting/get-the-statistics-of-routes /schema.json post /reporting/routes_statistics Retrieves task and log statistics for the specified routes within a given time window, accepting a request body with the required from and to timestamps and one or more route identifiers. Returns per-route statistics including counts of new, finished, and failed tasks along with log error counts and memory usage. # Get all available routes Source: https://docs.alumio.com/api-reference/routing/get-all-available-routes /schema.json get /routes Retrieves all available routes, returning a list of route entries with their identifier, name, and type along with action metadata. # General search Source: https://docs.alumio.com/api-reference/search/general-search /schema.json get /search Searches across configurations, tasks, and variables using the optional query string with predefined properties and search operators, and the optional filter expression. Returns each type as a separate group containing its matching results and metadata. # Set the preferred update cycle Source: https://docs.alumio.com/api-reference/settings/set-the-preferred-update-cycle /schema.json put /settings/update_cycle Sets the preferred Alumio update cycle, accepting either "latest" or "lts" in the request body. Returns the updated update cycle setting. # Allocate workers to a space Source: https://docs.alumio.com/api-reference/spaces/allocate-workers-to-a-space /schema.json post /space_workers/allocation Allocates a number of workers to each space from the list in the request body and returns the updated worker allocation. # Assign users to a space in bulk Source: https://docs.alumio.com/api-reference/spaces/assign-users-to-a-space-in-bulk /schema.json post /spaces/{space}/assign_users Assigns a list of users to the space identified by the space path parameter in a single bulk operation, using the users array provided in the request body. Returns the resulting set of spaces on success. # Assign workers to spaces Source: https://docs.alumio.com/api-reference/spaces/assign-workers-to-spaces /schema.json post /space_workers/list Assigns specific workers to spaces based on the worker identifiers supplied per space in the request body, and returns the updated worker assignments. # Cancel a space Source: https://docs.alumio.com/api-reference/spaces/cancel-a-space /schema.json delete /spaces/cancel/{identifier} Cancels the space identified by the path identifier so that it will be deleted on its expiration date, and returns a confirmation message. # Create a space Source: https://docs.alumio.com/api-reference/spaces/create-a-space /schema.json post /spaces Creates a space from the supplied identifier, name, purpose, and terms agreement, along with its initial users and data engine allocations. Returns the created space. # Create a space user Source: https://docs.alumio.com/api-reference/spaces/create-a-space-user /schema.json post /spaces/{space}/users Adds a user to the given space, assigning the email address and one or more roles supplied in the request body. Returns the created space user on success. # Delete a space user Source: https://docs.alumio.com/api-reference/spaces/delete-a-space-user /schema.json delete /spaces/{space}/users/{email} Removes the user identified by the email address from the given space, revoking their access. Returns a confirmation message. # Export audit trail Source: https://docs.alumio.com/api-reference/spaces/export-audit-trail /schema.json post /audit_trail/export Exports the audit trail entries as a downloadable file, optionally narrowing the result set with the form-encoded filter parameter. # Get a single space Source: https://docs.alumio.com/api-reference/spaces/get-a-single-space /schema.json get /spaces/{identifier} Retrieves a single space identified by the path identifier, returning its full details. # Get a single space user Source: https://docs.alumio.com/api-reference/spaces/get-a-single-space-user /schema.json get /spaces/{space}/users/{email} Retrieves a single user of the given space, identified by their email address. Returns the user's email, space, and assigned roles. # Get all statistics for a specific period Source: https://docs.alumio.com/api-reference/spaces/get-all-statistics-for-a-specific-period /schema.json get /spaces/tasks/statistics/totals Retrieves task log totals per space, broken down by status (new, processing, finished, failed, and skipped). Accepts optional dateFrom and dateTo query parameters to restrict the statistics to a specific period. # Get assigned space workers Source: https://docs.alumio.com/api-reference/spaces/get-assigned-space-workers /schema.json get /space_workers/allocation Retrieves the current worker allocation per space, including the total number of available workers and the number of workers available per space. # Get assigned space workers Source: https://docs.alumio.com/api-reference/spaces/get-assigned-space-workers-1 /schema.json get /space_workers/list Retrieves the list of workers assigned to each space, identified by their worker identifiers, along with the total number of available workers and the number of workers available per space. # Get audit trail item Source: https://docs.alumio.com/api-reference/spaces/get-audit-trail-item /schema.json get /audit_trail/item/{identifier} Retrieves a single audit trail item identified by the path identifier. Returns the audit trail item details, or an error response if the identifier cannot be resolved. # Get audit trail list Source: https://docs.alumio.com/api-reference/spaces/get-audit-trail-list /schema.json get /audit_trail/list Retrieves the list of audit trail entries, returning the matching items along with result metadata. Accepts an optional filter query parameter to narrow the results by search criteria. # Get space users Source: https://docs.alumio.com/api-reference/spaces/get-space-users /schema.json get /spaces/{space}/users Retrieves the list of users that have access to the given space, returned together with action metadata. Supports an optional filter query parameter to apply search criteria. # Get spaces Source: https://docs.alumio.com/api-reference/spaces/get-spaces /schema.json get /spaces Retrieves a paginated list of spaces along with metadata such as the total count and the space limit. Accepts an optional filter query parameter to apply search criteria. # Get usage info Source: https://docs.alumio.com/api-reference/spaces/get-usage-info /schema.json get /spaces/notifier/info Retrieves notifier usage information across spaces. # Reactivate a space Source: https://docs.alumio.com/api-reference/spaces/reactivate-a-space /schema.json get /spaces/reactivate/{identifier} Reactivates a previously canceled space identified by the path identifier and returns a confirmation message. # Search logs Source: https://docs.alumio.com/api-reference/spaces/search-logs /schema.json post /spaces/audit_trail Searches audit trail logs using the query supplied in the request body and returns the matching log entries. Accepts an optional index query parameter to select the log index to search, defaulting to filebeat-*. # Update a space Source: https://docs.alumio.com/api-reference/spaces/update-a-space /schema.json put /spaces Creates or updates a space from the supplied name, identifier, purpose, and optional description, and returns the resulting space object. # Update a space user Source: https://docs.alumio.com/api-reference/spaces/update-a-space-user /schema.json put /spaces/{space}/users/{email} Updates the user identified by the email address within the given space, replacing their email and roles with the values from the request body. Returns the updated space user. # Copy storage items from source to target Source: https://docs.alumio.com/api-reference/storage/copy-storage-items-from-source-to-target /schema.json post /storage/copy/{source}/{target} Copies all stored items from the source storage into the target storage, both identified by path parameters. Returns information about the copied objects. # Create a new entity in a storage Source: https://docs.alumio.com/api-reference/storage/create-a-new-entity-in-a-storage /schema.json post /storage/entity/{identifier} Creates a new entity in the storage identified by the path identifier, using the required entity query parameter as its key. Returns the created entity value with its last-updated timestamp. # Delete multiple entities from a storage Source: https://docs.alumio.com/api-reference/storage/delete-multiple-entities-from-a-storage /schema.json delete /storage/entities/{identifier} Deletes multiple entities from the storage identified by the path identifier, selecting which entities to remove via the filter in the request body. Returns a message describing the result. # Delete the content of a stored entity Source: https://docs.alumio.com/api-reference/storage/delete-the-content-of-a-stored-entity /schema.json delete /storage/entity/{identifier} Deletes a single stored entity, selected by the storage path identifier and the required entity query parameter. Returns a message describing the result. # Empty the stored entities Source: https://docs.alumio.com/api-reference/storage/empty-the-stored-entities /schema.json delete /storage/entities/{identifier}/empty/set Removes all entities from the storage identified by the path identifier, emptying it completely. Returns a message describing the result. # Export storage entities matching the filter Source: https://docs.alumio.com/api-reference/storage/export-storage-entities-matching-the-filter /schema.json post /storage/entities/{identifier}/export/bulk Exports entities from the storage identified by the path identifier that match the filter in the request body, with an optional clientTime hint. Streams the matching entities as a newline-delimited JSON (application/x-ndjson) response. # Get a list of storage entities Source: https://docs.alumio.com/api-reference/storage/get-a-list-of-storage-entities /schema.json get /storage/entities/{identifier} Retrieves the list of entities in the storage identified by the path identifier, optionally narrowed by the filter query parameter. Returns the matching entities along with metadata and a pagination cursor. # Prune storages Source: https://docs.alumio.com/api-reference/storage/prune-storages /schema.json post /storage/prune Prunes storages to remove expired or obsolete entries, optionally limited to a single storage via the identifier query parameter. Returns a message describing the result of the prune operation. # Create a system administrator Source: https://docs.alumio.com/api-reference/systemadministrator/create-a-system-administrator /schema.json post /system_administrators Creates a new system administrator from the supplied email address and roles, and returns the created administrator. # Delete the supplied system administrator Source: https://docs.alumio.com/api-reference/systemadministrator/delete-the-supplied-system-administrator /schema.json delete /system_administrators/{email} Deletes the system administrator identified by the email path parameter, and returns a confirmation message. # Get system administrators Source: https://docs.alumio.com/api-reference/systemadministrator/get-system-administrators /schema.json get /system_administrators Retrieves the list of system administrators, returning their email addresses and assigned roles. Accepts an optional filter query parameter to narrow the results by search criteria. # Get the requested system administrator Source: https://docs.alumio.com/api-reference/systemadministrator/get-the-requested-system-administrator /schema.json get /system_administrators/{email} Retrieves a single system administrator identified by the email path parameter, returning their email address and assigned roles. # Update a system administrator Source: https://docs.alumio.com/api-reference/systemadministrator/update-a-system-administrator /schema.json put /system_administrators/{email} Updates the system administrator identified by the email path parameter with the supplied email address and roles, and returns the updated administrator. # Delete a system administrator token Source: https://docs.alumio.com/api-reference/systemadministratortoken/delete-a-system-administrator-token /schema.json delete /system_administrator_tokens/{identifier} Deletes the system administrator token identified by the identifier path parameter, revoking access for that token immediately. Returns a confirmation message. # Generate a new system administrator token Source: https://docs.alumio.com/api-reference/systemadministratortoken/generate-a-new-system-administrator-token /schema.json post /system_administrator_tokens Generates a new system administrator token from the supplied name and optional description. Returns the generated access token together with its identifier. The access token is only shown once. A system administrator token grants system-wide administrative access to this environment, including managing spaces. By creating a token you accept responsibility for keeping it secret, sharing it only with parties that are allowed to administer this environment, and revoking it as soon as it is no longer needed. # Get a system administrator token Source: https://docs.alumio.com/api-reference/systemadministratortoken/get-a-system-administrator-token /schema.json get /system_administrator_tokens/{identifier} Retrieves a single system administrator token identified by the identifier path parameter. Returns the token's metadata such as name, description, creation details, and last used timestamp. # List system administrator tokens Source: https://docs.alumio.com/api-reference/systemadministratortoken/list-system-administrator-tokens /schema.json get /system_administrator_tokens Retrieves the list of system administrator token identifiers along with their metadata. Accepts an optional filter query parameter to apply search criteria. # Update a system administrator token Source: https://docs.alumio.com/api-reference/systemadministratortoken/update-a-system-administrator-token /schema.json patch /system_administrator_tokens/{identifier} Updates the name and description of the system administrator token identified by the identifier path parameter. Returns the updated token. # Get aggregated task statistics Source: https://docs.alumio.com/api-reference/tasklogger/get-aggregated-task-statistics /schema.json get /tasks/statistics Retrieves aggregated task log statistics grouped by date, returning per-status counts of new, processing, finished, failed, and skipped log items. Accepts an optional filter query parameter to narrow the results by search criteria. # Get all statistics for a specific period Source: https://docs.alumio.com/api-reference/tasklogger/get-all-statistics-for-a-specific-period /schema.json get /tasks/statistics/totals Retrieves aggregated task log statistics, returning the total counts of log items grouped by status (new, processing, finished, failed, and skipped). Accepts an optional filter for search criteria and dateFrom and dateTo parameters to restrict the totals to a specific period. # Get environment task statistics time series Source: https://docs.alumio.com/api-reference/tasklogger/get-environment-task-statistics-time-series /schema.json get /tasks/statistics/environment/time_series Retrieves a time series of task statistics for the environment, returning per-period counts of new, processing, finished, failed, and skipped task log items. Requires a filter to scope the results and accepts an optional aggregation level (daily, weekly, monthly, or yearly, defaulting to monthly). # Get the current task limits Source: https://docs.alumio.com/api-reference/tasklogger/get-the-current-task-limits /schema.json get /tasks/limits Retrieves the task usage limits for the current environment, returning the maximum number of tasks allowed alongside the number of tasks currently used. # Export task entity data Source: https://docs.alumio.com/api-reference/tasks/export-task-entity-data /schema.json get /tasks/{identifier}/entity-data/export Exports the entity data of the task identified by the path parameter. Returns the data as a downloadable JSON attachment. # Export tasks matching filter Source: https://docs.alumio.com/api-reference/tasks/export-tasks-matching-filter /schema.json post /tasks/export/bulk Exports all tasks matching the filter supplied in the form-encoded request body, using the optional clientTime value to align timestamps with the caller's timezone. # Get a task Source: https://docs.alumio.com/api-reference/tasks/get-a-task /schema.json get /tasks/{identifier} Retrieves a single task by its identifier, including detailed information such as entity data, context, status, route, and processing metadata. # Get task entity data Source: https://docs.alumio.com/api-reference/tasks/get-task-entity-data /schema.json get /tasks/{identifier}/entity-data Retrieves the entity data of the task identified by the given path identifier. Returns a JSON object containing the task's entity data under the data property. # List tasks Source: https://docs.alumio.com/api-reference/tasks/list-tasks /schema.json get /tasks Retrieves a paginated list of tasks, optionally narrowed by search criteria passed in the filter query parameter. Returns the matching tasks along with action metadata. # Patch tasks entity data Source: https://docs.alumio.com/api-reference/tasks/patch-tasks-entity-data /schema.json patch /tasks/{identifier}/entity-data Update the entity data of a task. Only tasks with status 'new' or 'failed' can be edited. # Prune tasks Source: https://docs.alumio.com/api-reference/tasks/prune-tasks /schema.json post /tasks/prune Deletes tasks older than the required maxAge or beyond the required maxCount most recent tasks, optionally restricted by the filter query parameter. Returns the number of tasks removed for being expired and for exceeding the count. # Repair stuck tasks Source: https://docs.alumio.com/api-reference/tasks/repair-stuck-tasks /schema.json post /tasks/repair/stuck Resets tasks that have been stuck for at least the given age (default 1 hour) to the newStatus (default new), optionally limited by the filter query parameter. Returns the number of tasks repaired and the status they were set to. # Resolve tasks matching filter Source: https://docs.alumio.com/api-reference/tasks/resolve-tasks-matching-filter /schema.json post /tasks/resolve/bulk Sets the status to resolved for all tasks matching the filter in the request body. Returns the new status and the number of tasks affected. # Retry tasks matching filter Source: https://docs.alumio.com/api-reference/tasks/retry-tasks-matching-filter /schema.json post /tasks/retry/bulk Sets the status to retry for all tasks matching the filter in the request body. Returns the new status and the number of tasks affected. # Set task status to failed Source: https://docs.alumio.com/api-reference/tasks/set-task-status-to-failed /schema.json post /tasks/waiting_to_failed/bulk Set the status of tasks from waiting to failed. # Set task status to finished Source: https://docs.alumio.com/api-reference/tasks/set-task-status-to-finished /schema.json post /tasks/waiting_to_finished/bulk Set the status of tasks from waiting to finished. # Skip tasks matching filter Source: https://docs.alumio.com/api-reference/tasks/skip-tasks-matching-filter /schema.json post /tasks/skip/bulk Sets the status to skipped for all tasks matching the filter in the request body. Returns the new status and the number of tasks affected. # Update waiting tasks in bulk Source: https://docs.alumio.com/api-reference/tasks/update-waiting-tasks-in-bulk /schema.json post /tasks/update_waiting/bulk Transitions waiting tasks to a finished or failed status in bulk, attaching the provided log messages to each identifier. Returns the number of tasks updated together with their details. # Execute a transformer Source: https://docs.alumio.com/api-reference/transformer/execute-a-transformer /schema.json post /transformers/execute Runs the transformer of the given "type" (defaulting to "list-transformer") against the supplied request body and returns the resulting entities. Supports debugging via the "breakpoints" and "stop-exec-at" query parameters to pause or halt execution at specific points. # Get UI schema by type Source: https://docs.alumio.com/api-reference/ui/get-ui-schema-by-type /schema.json get /ui/schema/{type} Retrieves the UI schema items for the type given in the path, returning them as a map of items under an object wrapper. # Create a new table filter for the user Source: https://docs.alumio.com/api-reference/users/create-a-new-table-filter-for-the-user /schema.json post /user-tables/filters Creates a new table filter for the current user from the supplied table key, name, and filter criteria. Returns the stored filter, including its generated identifier. # Create a user in the current space Source: https://docs.alumio.com/api-reference/users/create-a-user-in-the-current-space /schema.json post /current_space/users Creates a new user in the current space from the supplied email address and one or more roles. Returns the created user. # Delete a table filter by identifier Source: https://docs.alumio.com/api-reference/users/delete-a-table-filter-by-identifier /schema.json delete /user-tables/filters/{identifier} Deletes the table filter matching the given identifier. Returns a confirmation message once the filter has been removed. # Delete a user from the current space Source: https://docs.alumio.com/api-reference/users/delete-a-user-from-the-current-space /schema.json delete /current_space/users/{email} Removes the user identified by the email path parameter from the current space. Returns a confirmation message. # Get a single user from the current space Source: https://docs.alumio.com/api-reference/users/get-a-single-user-from-the-current-space /schema.json get /current_space/users/{email} Retrieves a single user from the current space identified by the email path parameter. Returns the user's email address and assigned roles. # Get accessible spaces for current user Source: https://docs.alumio.com/api-reference/users/get-accessible-spaces-for-current-user /schema.json get /user/spaces Retrieves the list of spaces the currently authenticated user has access to, including each space's identifier, name, and the user's roles within it. # Get current logged-in user Source: https://docs.alumio.com/api-reference/users/get-current-logged-in-user /schema.json get /users/current Retrieves the profile of the currently authenticated user based on the request's credentials. Returns the user details as a UserResponse. # Get the table filters Source: https://docs.alumio.com/api-reference/users/get-the-table-filters /schema.json get /user-tables/filters Retrieves the list of saved table filters for the current user. Accepts an optional filter query parameter to narrow the results by search criteria. # Get users of the current space Source: https://docs.alumio.com/api-reference/users/get-users-of-the-current-space /schema.json get /current_space/users Retrieves the list of users belonging to the current space, each with their email address and assigned roles. Accepts an optional filter query parameter to apply search criteria. # Save updated user preferences Source: https://docs.alumio.com/api-reference/users/save-updated-user-preferences /schema.json put /users/preferences/update Updates the authenticated user's preferences by merging the supplied updatedPreferences object into the stored settings. Returns the updated user, including the new preferences. # Update a table filter by identifier Source: https://docs.alumio.com/api-reference/users/update-a-table-filter-by-identifier /schema.json put /user-tables/filters/{identifier} Updates the table filter matching the given identifier with the supplied table key, name, and filter criteria. Returns the updated filter. # Update a user in the current space Source: https://docs.alumio.com/api-reference/users/update-a-user-in-the-current-space /schema.json put /current_space/users/{email} Updates the user in the current space identified by the email path parameter, replacing their assigned roles with those in the request body. Returns the updated user. # Update user preferences in the current space Source: https://docs.alumio.com/api-reference/users/update-user-preferences-in-the-current-space /schema.json put /current_space/user_preferences/update Updates the preferences of the current user in the current space using the preference values supplied in the request body. Returns the updated user. # Accelo Source: https://docs.alumio.com/connectors/accelo Connect Alumio to Accelo. ## Extra information System documentation: [WooCommerce API Reference ](https://woocommerce.github.io/woocommerce-rest-api-docs/) ## Connector package documentation **Accelo** # Setting up HTTP Client Accelo ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Accelo HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, and Authentication type, Client ID, Client Secret, and Scopes (optional). 3. Save the Client for use later. # Subscribing to Entities from Accelo ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Accelo Subscriber as the subscriber. 2. Select the entity you want to subscribe from Accelo. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Accelo HTTP Client to use. ## General Concept We follow Accelo documentation on building this connector so you can easily use the connector based on Accelo API Reference. **Entity** It’s the entity you want to subscribe from Accelo. Please refer to the entities in Management APIs from Accelo API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Accelo API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get Activity entity Accelo connector screenshot 1 Accelo connector screenshot 2 That’s why we need to define the **activity\_id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get Activity. /activities/24 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Accelo. # Publishing Entity to Accelo ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Accelo Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Accelo entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Accelo. 6. Select the HTTP Client to use. Accelo connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Accelo endpoints. Please refer to the entities in Management APIs from the Accelo API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Remove Company. Please select “Delete” as the action and “Remove a Company” as the entity of the publisher. Accelo connector screenshot 4 Accelo connector screenshot 5 You can put the payload you want to send to Accelo into the payload property in the data. Alumio will send an API request to Accelo with URL /companies/\{company\_id} **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Accelo. # Act-On Source: https://docs.alumio.com/connectors/act-on Connect Alumio to Act-On. ## Extra information Connector package documentation: System documentation: ## Setting up HTTP Client Act-On **Steps** 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Act-On HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Client ID, Client Secret, Username, and Password. 3. Scopes is optional. 4. Choose Content-Type (Explained at Important Notes Below) ## Subscribing to Entities from Act-On **Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select Act-On Subscriber as the subscriber. 2. Select the entity you want to subscribe from Act-On. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Act-On HTTP Client to use **General Concept** We follow Act-On documentation on building this connector so you can easily use the connector based on Act-On API Reference. **Entity** It’s the entity you want to subscribe from Act-On. Please refer to the entities in Management APIs from Act-On API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Act-On API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity Act-On connector screenshot 1 Act-On connector screenshot 2 That’s why we need to define the **listid**, and **recordid** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such a Request Parameters field. /api/1/list/123/record/123/facts **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Act-On. ## Publishing Entity to Act-On **Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Act-On Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Act-On entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Act-On. 6. Select the HTTP Client to use. **General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Act-On endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from the Act-On API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a User. Please select “Create” as the action and “Create Bew Account User(s)” as the entity of the publisher. Act-On connector screenshot 3 Act-On connector screenshot 4 You can put the payload you want to send to Act-On into the payload property in the data. Here is an example of the Possible Response after Creation. Act-On connector screenshot 5 Act-On connector screenshot 6 Alumio will send an API request to Act-On with URL /api/1/user **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Act-On. *** ## Important Notes **On the endpoints, we do not support query on Input** see that the Endpoint is /api/1/list/\{listid}/record?email=\{emailaddress}. In Alumio we make it like this. /api/1/list/\{listid}/record we didn't insert any query on this one, in this case, you have to insert manually on the parameter like this. ``` { "path": [], "query": { "email": "emailAdressHere" }, "payload": [] } ``` **We Currently are not supporting File (-F) type of Payload in Alumio.** ex : Act-On connector screenshot 7 **For the Data Payload,** ex : Act-On connector screenshot 8 In this case, you have to create another Client and Publisher for it. Please look at the Publisher I’ve created. Act-On connector screenshot 9 See that the Content-Type is form-urlencoded. Take a look at the Client, and see the Content Type is form-urlencoded. In this case, you have to create 2 clients and 2 publishers for Json and URL-encoded and use it differently. # Adyen Source: https://docs.alumio.com/connectors/adyen Connect Alumio to Adyen. ## Extra information System documentation: [\[Adyen API Reference\]](https://docs.adyen.com/api-explorer/) # Setting up HTTP Client Adyen ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Adyen HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, and Choose the Authentication Type. * Basic : Fill the Username and Password * Api Key : Fill in the Api Key * Save the Client for use later. # Subscribing to Entities from Adyen ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Adyen Subscriber as the subscriber. * Select the entity you want to subscribe from Adyen. * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the Adyen HTTP Client to use. ## General Concept We follow Adyen documentation on building this connector so you can easily use the connector based on Adyen API Reference. **Entity** It’s the entity you want to subscribe from Adyen. Please refer to the entities in Management APIs from Adyen API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Adyen API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get a company acount entity. Adyen connector screenshot 1 Adyen connector screenshot 2 That’s why we need to define the **companyId** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get a company account. /v3/companies/AlumioTestingSite **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Adyen. # Publishing Entity to Adyen ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Adyen Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the Adyen entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to Adyen. * Select the HTTP Client to use. Adyen connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Adyen endpoints. Please refer to the entities in Management APIs from the Adyen API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create an Order. Please select “Post” as the action and “Create an order” as the entity of the publisher. Adyen connector screenshot 4 Adyen connector screenshot 5 You can put the payload you want to send to Adyen into the payload property in the data. Alumio will send an API request to Adyen with URL /v71/orders **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Adyen. # AFAS Source: https://docs.alumio.com/connectors/afas Connect Alumio to AFAS Profit. ## Extra information System documentation: [https://help.afas.nl/help/EN/SE/App\_Cnr\_Rest\_Api.htm](https://help.afas.nl/help/EN/SE/App_Cnr_Rest_Api.htm) Find shared AFAS configurations in our [Exchange configuration category](https://forum.alumio.com/c/ipaas-general/exchange-configuration/146). ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client AFAS * **1.1** Steps * **2.** Subscribing to Entities from AFAS * **2.1** Steps * **2.2** General Concept * **3.** Publishing Entity to AFAS * **3.1** Steps * **3.2** General Concept ### 1. Setting up HTTP Client AFAS **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. 2. Create a new HTTP Client and select AFAS Client as the prototype of the HTTP Client. 3. AFAS has a URL with an environment ID that needs to be filled in along with the Base64 of the AFAS token that you would like to use. AFAS connector screenshot 1 ### 2. Subscribing to Entities from AFAS **2.1 Steps** 1. Go to Connections -> Incoming, create a new incoming configuration and select AFAS Subscriber as the subscriber. 2. Select the AFAS HTTP Client to use. 3. (Optional) Add any request parameters needed to subscribe to the entity. 4. (Optional) Add a transformer to modify the request parameters into something you need. **2.2 General Concept** AFAS uses a custom connector for using the subscriber. Please fill the Entity based on the connector name in the AFAS application. AFAS connector screenshot 2 **Entity** Fill in the connector name that you created in the AFAS application. **Request Parameters** These are the parameters you can provide to get the needed Entity based on the AFAS API Docs. As an example, to get an "Order" that’s dated in the year 2022, you can fill it in as follows: AFAS connector screenshot 3 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is defined set of parameters attached to the end of a url. For example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) **Input Transformer** Any transformers set here will be executed after the "Request Parameters" are loaded. This means you can basically add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** This refers to the HTTP Client configuration you will use to access AFAS. ### 3. Publishing Entity to AFAS **3.1 Steps** 1. Go to Connections -> Outgoing, to create a new outgoing configuration and select the AFAS – Entity Publisher as the Publisher. 2. Optionally, you can also add any transformers to modify the data into anything you need before submitting it to AFAS. 3. Select the AFAS HTTP Client to use. 4. Fill in the AFAS connector name with the same one used in the AFAS application. AFAS connector screenshot 4 **3.2 General Concept** AFAS uses a custom connector to use the Publisher. Please fill the Entity based on the connector name used in the AFAS application. **Method** You can select the method of Post, Update or Delete to do what you want with the Publisher. **Entity** To fill data using the Alumio AFAS connector, you need to use the Alumio standard pathing and fill the payload with the data you need to add to AFAS, as an example, when we creating an order. AFAS connector screenshot 5 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * "Payload" is the data contained within a request. Alumio will send an API request to AFAS based on the setting **HTTP Client** This is the HTTP Client configuration you will use to access AFAS. # Aha! Source: https://docs.alumio.com/connectors/aha Connect Alumio to Aha!. ## Extra information System documentation: [Aha! API Reference](https://www.aha.io/api) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Aha! * **1.1** Steps * **2.** Subscribing to entities from Aha! * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Aha! * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Aha! **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Aha! HTTP Client as PlatForm and click next step 3. Fill in the Base URI, Token URL, Authorize URL, Client ID and Client Secret. (See the [Aha! Authentication Documentation](https://www.aha.io/api) for more information) 4. Click on "Grant access to Aha!" and you will be redirected to Aha! website to get the key for the client. 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. Aha! connector screenshot 1 ### 2. Subscribing to Entities from Aha! **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Aha! Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from Aha!. 3. Add any request parameters needed to subscribe to the entity. 4. Select the Aha! HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from Aha!. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Aha! documentation on building this connector, so you can easily use the connector based on [Aha! API Reference](https://www.aha.io/api). **Entity** The entity you want to subscribe to Aha!. Please refer to the entities from [Aha! API Reference](https://www.aha.io/api) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Aha! API Reference](https://www.aha.io/api). Please look at the example below on how to fill path field when we want retrieve list comments by subscribing ["Comments API - List comments on a goal"](https://www.aha.io/api/resources/comments/list_comments_on_a_goal) entity. Aha! connector screenshot 2 Aha! connector screenshot 3 From the end point, we can see that we need to set the goal id as parameters. That is why we set the "goal\_id" inside the path key in the Request Parameters. Alumio will then make a request to Aha! with the URL `/api/v1/goals/7416189478687263166/comments` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access Aha!. ### 3. Publishing Entity to Aha! **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Aha! Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the Aha! entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to Aha!. **Entity** We support publishing to most Aha! endpoints. Please refer to [Aha! API Reference](https://www.aha.io/api) page. For example, we want to update a product. Please select “Put” as the Method and ["Products API - Update a product"](https://www.aha.io/api/resources/products/update_a_product). Aha! connector screenshot 4 Aha! connector screenshot 5 From the documentation, we can see that we need to set a path parameter and a body parameters. That is why we set the "id" inside the path key and body parameters inside the payload key in the data. Aha! connector screenshot 6 Alumio will send an API request to Aha! with URL `/api/v1/products/7416573148990007139` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Aha!. # Airfocus Source: https://docs.alumio.com/connectors/airfocus Connect Alumio to Airfocus. ## Extra information System documentation: \[Airfocus API Reference] **Airfocus** **Connector Package Documentation** # Setting up HTTP Client Airfocus ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Airfocus HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, and Api Key. * Save the Client for use later. # Subscribing to Entities from Airfocus ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Airfocus Subscriber as the subscriber. * Select the entity you want to subscribe from Airfocus . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the Airfocus HTTP Client to use. ## General Concept We follow Airfocus documentation on building this connector so you can easily use the connector based on Airfocus API Reference. **Method** It’s the Method you want to subscribe from Airfocus. Based on the Method, the Entity will change. Please refer to the entities in Management APIs from Airfocus API Reference page. **Entity** It’s the entity you want to subscribe from Airfocus . Please refer to the entities in Management APIs from Airfocus API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Airfocus API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Retrieve a single field. Airfocus connector screenshot 1 Airfocus connector screenshot 2 That’s why we need to define the **fieldId** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Retrieve a single field. /api/fields/abc123 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Airfocus . # Publishing Entity to Airfocus ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Airfocus Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the Airfocus entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to Airfocus . * Select the HTTP Client to use. Airfocus connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Patch (HTTP PATCH method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Airfocus endpoints. Please refer to the entities in Management APIs from the Airfocus API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Update a workspace. Please select “Put” as the action and “Update an existing workspace” as the entity of the publisher. Airfocus connector screenshot 4 Airfocus connector screenshot 5 You can put the payload you want to send to Airfocus into the payload property in the data. Alumio will send an API request to Airfocus with URL /api/workspaces/workspace123 **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Airfocus . # Akeneo Source: https://docs.alumio.com/connectors/akeneo Connect Alumio to Akeneo. ## Extra information System documentation Akeneo REST API: [https://api.akeneo.com/api-reference.html](https://api.akeneo.com/api-reference.html) System documentation Akeneo GraphQL: [https://api.akeneo.com/graphql/getting-started.html](https://api.akeneo.com/graphql/getting-started.html) ## Connector package documentation \[details="Akeneo REST API"] ### 1. Setting up the Akeneo HTTP Client **1.1 Steps** 1. In the Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select the Akeneo HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Client ID, Client Secret, Username, Password, and Authentication Method Note: We recommend using Body as an Authentication Method. 3. Press “Grant Access to Akeneo”. 4. The Key will show up and you can save the Client for use. ### 2. Subscribing to entities from Akeneo **2.1 Steps** 1. Go to Connections -> Incoming, create a new incoming configuration and select the Akeneo Subscriber. 2. Select the entity you want to subscribe to from Akeneo. 3. (Optional) Add any request parameters needed to subscribe to the entity. 4. You can also add a transformer to modify the request parameters into something you need. 5. Select the Akeneo HTTP Client to use. 6. You can add a pagination feature to allow Alumio to fetch a paginated entity. **2.2 General Concept** We follow Akeneo documentation for building this connector, so you can easily use the connector based on the Akeneo API Reference. **Entity** This is the entity you want to subscribe to from Akeneo. Please refer to the entities in Management APIs from the Akeneo API Reference page. **Request Parameters** These are the parameters you can provide to get the needed Entity based on the Akeneo API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing the "All Parcels" Entity. Akeneo connector screenshot 1 * The property `path` is the path parameter of the URL. For example, the `{id}`. * The property `query` is a defined set of parameters attached to the end of a URL.\ Example: `www.url.com?type=true&start=0` Akeneo connector screenshot 2 This is why you need to define the code property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. The final URL will be like this `/api/rest/v1/products/123`. **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you can basically add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an Entity. **HTTP Client** This is the HTTP Client configuration or prototype you will use to access Akeneo. ### 3. Publishing entities to Akeneo **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select the Akeneo Publisher as the Publisher. 2. Select the action that you want the Publisher to do with the data. 3. Select the Akeneo entity where you want the data to be published. 4. Optionally, you can add any query parameters to the request. 5. You can also add any transformers to modify the data into anything you need before submitting it to Akeneo. 6. Select the HTTP Client to use. Akeneo connector screenshot 3 **3.2 General Concept** Like the Subscriber, the Publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Akeneo endpoints, but not with publishing binary files for now. Please refer to the entities in Management APIs from the Akeneo API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For example, we want to delete a Product. Please select “Delete” as the action and [“Delete a Product”](https://api.akeneo.com/api-reference.html#delete_products__code_) as the entity of the publisher. Akeneo connector screenshot 4 Akeneo connector screenshot 5 As you can see, we need to add `code` in the Path, so please make sure we add `code` inside the `path` key in the data. For example: Akeneo connector screenshot 6 Alumio will send an API request to Akeneo with URL `/api/rest/v1/products/123` Another example is when we want to update several products at once. Please select “Patch” as the Action and ["Update/create Several Products"](https://api.akeneo.com/api-reference.html#patch_products) as the entity of the publisher. Akeneo connector screenshot 7 Akeneo connector screenshot 8 Based on the documentation, we can see that the endpoint requires the product data as the body. In order to achieve this, we should provide the product data in our data in the key `payload` within Alumio. Akeneo connector screenshot 9 Akeneo will process the request and return a response (please enable logging in HTTP Client to make this visible). Akeneo connector screenshot 10 You may look that in the documentation, the endpoint requires us to provide [NDJSON](http://ndjson.org/) format to send to Akeneo. Akeneo connector screenshot 11 Rest assured, our Akeneo connector has the capability to automatically change the JSON input to NDJSON format, based on the endpoint's documentation at Akeneo. Akeneo connector screenshot 12 * The property `path` is the path parameter of the URL. For example, the `{id}`. * The property `query` is a defined set of parameters attached to the end of a URL.\ Example: `www.url.com?type=true&start=0` * The property `payload` is the data contained within a request. **HTTP Client** This is the HTTP Client configuration or prototype you will use to access Akeneo. \[/details] \[details="Akeneo GraphQL"] **Connector Package Documentation** # Setting up HTTP Client Akeneo GraphQL ## Steps * In Alumio Dashboard, go to Clients > HTTP Client. Create a new HTTP Client and select Akeneo GraphQL Client as the prototype of the HTTP Client. * Fill in the Base URI, X-PIM-URL, Username, Password, X-PIM-Client-ID or Client ID, and Client Secret. * Save and Continue. # Subscribing to Entities from Akeneo GraphQL ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Akeneo - GraphQL Subscriber as the subscriber. * Add any Request URI that you need to add from the Base URI from Client. * Select the HTTP Method you want to subscribe to from Akeneo GraphQL (Recommended POST). * Add any request data in the request parameter that you needed to subscribe to the entity. * You can optionally add a transformer to transform the request parameters into something you need. * Select the Akeneo GraphQL HTTP Client to use. ## General Concept We follow Akeneo GraphQL documentation on building this connector so you can easily use the connector based on Akeneo GraphQL API Reference. **Request URI** It’s the Endpoint you want to subscribe from Akeneo. **Request Method** It’s the HTTP Method that you want to use, we recommend using post as default method. **Request Parameters** These are the parameters you can provide to get the needed entity based on Akeneo GraphQL API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing productModels. Akeneo connector screenshot 13 **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Akeneo GraphQL. # Publishing Entity to Akeneo GraphQL ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Akeneo Publisher as the publisher. * Select the Request URI you want the data to be published. * Select the Request Method that you want the publisher to do with the data. * Add any request data in the request parameter that you needed to subscribe to the entity. * Select the HTTP Client to use. ## General Concept Like the subscriber, the publisher has similar methods on how to use it. **Request Parameters** Please refer to the entities in Management APIs from the Akeneo GraphQL API Reference page. Please look at the example below. For example, we want to Get Product List Akeneo connector screenshot 14 You can put the payload you want to send to Akeneo GraphQL into the Request Parameters . **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Akeneo GraphQL. \[/details] # Algolia Source: https://docs.alumio.com/connectors/algolia Connect Alumio to Algolia. ## Extra information System documentation: [Algolia API Reference](https://www.algolia.com/doc/rest-api/search/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Algolia * **1.1** Steps * **2.** Subscribing to entities from Algolia * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Algolia * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Algolia **1.1 Steps** 1. In Algolia Dashboard, go to Settings -> Organization Settings -> Teams and Access -> API Keys. You can manage the Application ID, and API Keys. Please make sure you choose the right API keys for your need. (For more information, see [Algolia API Keys](https://www.algolia.com/doc/guides/security/api-keys/)) 2. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select Algolia Client as the HTTP Client. 3. Fill in the Base URI, Algolia Application ID, and Algolia API Key. (For more information, see [Algolia Hosts](https://www.algolia.com/doc/rest-api/search/#hosts)) 4. You can optionally enable logging of request to get the log of the authentication. 5. Save the HTTP Client for use. Algolia connector screenshot 1 ### 2. Subscribing to Entities from Algolia **2.1 Steps** 1. Go to Connections -> Incoming, create a new incoming configuration, and select Algolia Subscriber as the subscriber. 2. Select the entity you want to subscribe to from Algolia. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you will request from Algolia. 5. Select the Algolia HTTP Client to use. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Algolia documentation on building this connector, so you can easily use the connector based on [Algolia API Reference](https://www.algolia.com/doc/rest-api/search/). **Entity** The entity you want to subscribe to Algolia. Please refer to the entities from [Algolia API Reference](https://www.algolia.com/doc/rest-api/search/) page. **Request Parameters** You can provide these parameters to get the needed entity based on the [Algolia API Reference](https://www.algolia.com/doc/rest-api/search/). Please look at the example below on how to fill the path field when subscribing ["Search Index"](https://www.algolia.com/doc/rest-api/search/#search-endpoints) entity. Algolia connector screenshot 2 Algolia connector screenshot 3 Based on the documentation, we can see that the endpoint requires "indexName" as a path. That is why we set the "indexName" inside the path key in the Request Parameters. * Path is the path parameter of the url. For example, the \{id}. * Query is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then make a request to Algolia with the URL /1/indexes/123 **Input Transformer** Any transformer’s set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** The HTTP Client configuration you will use to access Algolia. ### 3. Publishing Entity to Algolia **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Algolia Publisher as the publisher. 2. Select the action that you want the publisher to perform with the data. 3. Select the Algolia entity you want the data to be published. 4. You can optionally add any path data to the request on the key path. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. 7. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). However, you can also add or modify the payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), Patch (HTTP PATCH Method), and Delete (HTTP DELETE method) on submitting data to Algolia. **Entity** We support publishing to most Algolia endpoints. Please refer to [Algolia API Reference](https://www.algolia.com/doc/rest-api/search/) page. For example, we want to use [“Delete object”](https://www.algolia.com/doc/rest-api/search/#objects-endpoints) entity. Please select “Delete” as the Action and [“Delete object”](https://www.algolia.com/doc/rest-api/search/#objects-endpoints) as the entity of the publisher. Algolia connector screenshot 4 Algolia connector screenshot 5 Based on the documentation, we can see that the endpoint requires "indexName" and "objectID" as a path. That is why we set the "indexName" and "objectID" inside the path key in the data. Algolia connector screenshot 6 Alumio will send an API request to Algolia with URL /1/indexes/contacts/myID. Another example is when we want to use [“Add/replace object (with ID)”](https://www.algolia.com/doc/rest-api/search/#objects-endpoints) entity. Please select “Update” as the Action and [“Add/replace object (with ID)”](https://www.algolia.com/doc/rest-api/search/#objects-endpoints) as the entity of the publisher. Algolia connector screenshot 7 Algolia connector screenshot 8 You can put the payload you want to send to Algolia into the payload key in the data. Here is an example of the possible Data for [“Add/replace object (with ID)”](https://www.algolia.com/doc/rest-api/search/#objects-endpoints). Algolia connector screenshot 9 Alumio will send an API request to Algolia with URL /1/indexes/contacts/myID. * Path is the path parameter of the url. For example, the \{id}. * Query is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Algolia. # Amazon Selling Partner Source: https://docs.alumio.com/connectors/amazon-selling-partner Connect Alumio to Amazon Selling Partner. ## Extra information System documentation: [\[Amazon Selling Partner API Reference\]](https://developer-docs.amazon.com/sp-api/docs/welcome) **Amazon Selling Partner** **Connector Package Documentation** # Setting up HTTP Client Amazon Selling Partner ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Amazon Selling Partner HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, and Client ID, Client Secret, and Refresh Token. 3. Save the Client for use later. # Subscribing to Entities from Amazon Selling Partner ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Amazon Selling Partner Subscriber as the subscriber. 2. Select the entity you want to subscribe from Amazon Selling Partner. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Amazon Selling Partner HTTP Client to use. ## General Concept We follow Amazon Selling Partner documentation on building this connector so you can easily use the connector based on Amazon Selling Partner API Reference. **Entity** It’s the entity you want to subscribe from Amazon Selling Partner. Please refer to the entities in Management APIs from Amazon Selling Partner API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Amazon Selling Partner API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing getCatalogItem Amazon Selling Partner connector screenshot 1 Amazon Selling Partner connector screenshot 2 That’s why we need to define the **asin** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on getCatalogItem. /catalog/v0/items/**KCL123B** **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Amazon Selling Partner. # Publishing Entity to Amazon Selling Partner ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Amazon Selling Partner Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the Amazon Selling Partner entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to Amazon Selling Partner. * Select the HTTP Client to use. Amazon Selling Partner connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Amazon Selling Partner endpoints. Please refer to the entities in Management APIs from the Amazon Selling Partner API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create Scheduled Package. Please select “Post” as the action and “createScheduled Package” as the entity of the publisher. Amazon Selling Partner connector screenshot 4 You can put the payload you want to send to Amazon Selling Partner into the payload property in the data. Alumio will send an API request to Amazon Selling Partner with URL /easyShip/2022-03-23/package **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Amazon Selling Partner. # AS2 Gateway Source: https://docs.alumio.com/connectors/as2-gateway Connect Alumio to AS2 Gateway. ## Extra information System documentation: [AS2 Gateway API Reference](https://aayutechnologies.com/docs/product/as2-gateway/rest-api-integration/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client AS2 Gateway * **1.1** Steps * **2.** Subscribing to entities from AS2 Gateway * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to AS2 Gateway * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client AS2 Gateway **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select AS2 Gateway HTTP Client as PlatForm and click next step 3. Fill in the Base URI, Username and Password. 4. You can optionally enable caching of the token and set Alumio storage to store the token. 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. ### 2. Subscribing to Entities from AS2 Gateway **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "AS2 Gateway Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from AS2 Gateway. 3. Add any request parameters needed to subscribe to the entity. 4. Select the AS2 Gateway HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from AS2 Gateway. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. AS2 Gateway connector screenshot 1 **2.2 General Concept** We follow AS2 Gateway documentation on building this connector, so you can easily use the connector based on [AS2 Gateway API Reference](https://aayutechnologies.com/docs/product/as2-gateway/rest-api-integration/). **Entity** The entity you want to subscribe to AS2 Gateway. Please refer to the entities from [AS2 Gateway API Reference](https://aayutechnologies.com/docs/product/as2-gateway/rest-api-integration/) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [AS2 Gateway API Reference](https://aayutechnologies.com/docs/product/as2-gateway/rest-api-integration/) . Please look at the example below on how to fill path field when subscribing "Retrieving a Received AS2 Message entity. AS2 Gateway connector screenshot 2 AS2 Gateway connector screenshot 3 From the end point, we can see that we need to set "as2\_message\_id" as parameters. That is why we set the "as2\_message\_id" inside the path key in the Request Parameters. Alumio will then make a request to AS2 Gateway with the URL `/v1/message/received/<1612348314.4843.1712128400537@as2gateway.com>` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access AS2 Gateway. ### 3. Publishing Entity to AS2 Gateway **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "AS2 Gateway Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the AS2 Gateway entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, HTTP Patch method, HTTP Put method and HTTP Delete method on submitting data to AS2 Gateway. **Entity** We support publishing to most AS2 Gateway endpoints. Please refer to [AS2 Gateway API Reference](https://aayutechnologies.com/docs/product/as2-gateway/rest-api-integration/) page. For example, we want to add a new contact. Please select “Post” as the Method and "Sending AS2 Messages" as the entity of the publisher. AS2 Gateway connector screenshot 4 AS2 Gateway connector screenshot 5 Based on the documentation, it requires "as2\_station\_id" and "as2\_partner\_id" as parameters, it also requires multipart request body. Please go into the "Advanced" tab and set the "as2\_station\_id" and "as2\_partner\_id" inside the path key inside Advanced Path Parameters. Then we set "Body type" as "Multipart/form-data". Because AS2 require file as Key, please always set the Key into file. Please set the other field as you need. AS2 Gateway connector screenshot 6 Alumio will send an API request to AS2 Gateway with URL /v1/message/ALUMIO123/PARTNER123 * Path Parameters is the path parameter of the url. For example the \{id}. * Query Parameters is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Body Type and Parameter will determine the data you will send inside the request **HTTP Client** The HTTP Client configuration you will use to access AS2 Gateway. # Asana Source: https://docs.alumio.com/connectors/asana Connect Alumio to Asana. ## Extra information System documentation: [Asana API Reference](https://developers.asana.com/reference/rest-api-reference) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Asana * **1.1** Steps * **2.** Subscribing to entities from Asana * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Asana * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Asana **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select "Asana HTTP Client" as the HTTP Client. 2. We support Personal access token authentication and Oauth Authentication (For more information, see [Asana Authentication Reference](https://developers.asana.com/docs/authentication)) (Please press the button Grant access to Asana when using oauth) 3. You can optionally enable logging of request to get the log of the authentication. 4. Save the HTTP Client for use. Asana connector screenshot 1 ### 2. Subscribing to Entities from Asana **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Asana Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from Asana. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you will request from Asana. 5. You can also optionally enable pagination to allow Alumio fetches paginated entities. 6. Select the Asana HTTP Client to use. **2.2 General Concept** We follow Asana documentation on building this connector, so you can easily use the connector based on [Asana API Reference](https://developers.asana.com/reference/rest-api-reference). **Entity** The entity you want to subscribe to Asana. Please refer to the entities from [Asana API Reference](https://developers.asana.com/reference/rest-api-reference). **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Asana API Reference](https://developers.asana.com/reference/rest-api-reference). Please look at the example below on how to fill path field when subscribing ["Get teams in a workspace"](https://developers.asana.com/reference/getteamsforworkspace) entity. Asana connector screenshot 2 Asana connector screenshot 3 Based on the documentation, we can see that the end point require "workspace\_gid" as a path. That is why we set the "workspace\_gid" inside the path key in the Request Parameters. * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then make a request to Asana with the URL /workspaces/1204588700815234/teams **HTTP Client** The HTTP Client configuration you will use to access Asana. ### 3. Publishing Entity to Asana **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Asana Publisher" as the publisher. 2. Select the Action that you want the publisher to perform with the data. 3. Select the Asana entity you want the data to be published to. 4. You can optionally add any path data to the request on the key path. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. 7. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method) on submitting data to Asana. **Entity** We support publishing to most Asana endpoints. Please refer to [Asana API Reference](https://developers.asana.com/reference/rest-api-reference) page. For example, we want to create a team. Please select "Create" for the Action then ["Create a team"](https://developers.asana.com/reference/createteam) as the entity of the publisher. Asana connector screenshot 4 Asana connector screenshot 5 Based on the documentation, we need to add data. So we put the data inside the payload key in the Alumio Data. Asana connector screenshot 6 Alumio will send an API request to Asana with URL /teams * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Asana. # Atlassian Confluence Cloud Source: https://docs.alumio.com/connectors/atlassian-confluence-cloud Connect Alumio to Atlassian Confluence Cloud. ## Extra information System documentation: ## Connector package documentation # Setting up HTTP Client Confluence Cloud ## Steps 1. In Alumio Dashboard, go to Clients > HTTP Clients. Create a new HTTP Client and select Confluence Cloud HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Username, Password. # Subscribing to Entities from Confluence Cloud ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Confluence Cloud Subscriber as the subscriber. 2. Select the entity you want to subscribe from Confluence Cloud. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. ## Select the Confluence Cloud HTTP Client to use. General Concept We follow Confluence Cloud documentation on building this connector so you can easily use the connector based on Confluence Cloud API Reference. **Entity** It’s the entity you want to subscribe from Confluence Cloud. Please refer to the entities in Management APIs from Confluence Cloud API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Confluence Cloud API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity. Atlassian Confluence Cloud connector screenshot 1 Atlassian Confluence Cloud connector screenshot 2 That’s why we need to define **id and versionNumber** property inside **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on coupon entity. /wiki/rest/api/content/1/version/123 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Confluence Cloud. # Publishing Entity to Confluence Cloud ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration and select Confluence Cloud Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Confluence Cloud entity you want the data to be published to. 4. Select the HTTP Client to use. Atlassian Confluence Cloud connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Confluence Cloud endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Confluence Cloud API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a Thread. Please select “Create” as the action and “Create new user group” as the entity of the publisher. Atlassian Confluence Cloud connector screenshot 4 Atlassian Confluence Cloud connector screenshot 5 You can put the payload you want to send to Confluence Cloud into payload property in the data. Here is an example of the Possible Response after Creation. Atlassian Confluence Cloud connector screenshot 6 Atlassian Confluence Cloud connector screenshot 7 Atlassian Confluence Cloud connector screenshot 8 Atlassian Confluence Cloud connector screenshot 9 Alumio will send an API request to Confluence Cloud with URL /wiki/rest/api/group **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Confluence Cloud. # Atlassian Jira Cloud Source: https://docs.alumio.com/connectors/atlassian-jira-cloud Connect Alumio to Atlassian Jira Cloud. ## Extra information System documentation: **Atlassian Jira Cloud** ## Connector Package Documentation\*\* # Setting up HTTP Client Atlassian Jira Cloud ## Steps 1. In Alumio Dashboard, go to Clients > HTTP Clients. Create a new HTTP Client and select Atlassian Jira Cloud HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Username, and Password. # Subscribing to Entities from Atlassian Jira Cloud ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Atlassian Jira Cloud Subscriber as the subscriber. 2. Select the entity you want to subscribe from Atlassian Jira Cloud. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. ## Select the Atlassian Jira Cloud HTTP Client to use. General Concept We follow Atlassian Jira Cloud documentation on building this connector so you can easily use the connector based on Atlassian Jira Cloud API Reference. **Entity** It’s the entity you want to subscribe from Atlassian Jira Cloud. Please refer to the entities in Management APIs from Atlassian Jira Cloud API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Atlassian Jira Cloud API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity Atlassian Jira Cloud connector screenshot 1 Atlassian Jira Cloud connector screenshot 2 The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on coupon entity. /rest/api/3/user?accountId= 5b10ac8d82e05b22cc7d4ef5 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Atlassian Jira Cloud. # Publishing Entity to Atlassian Jira Cloud ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration and select Atlassian Jira Cloud Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Atlassian Jira Cloud entity you want the data to be published to. 4. Select the HTTP Client to use. Atlassian Jira Cloud connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Atlassian Jira Cloud endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Atlassian Jira Cloud API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a User. Please select “Create” as the action and “Create User” as the entity of the publisher. Atlassian Jira Cloud connector screenshot 4 You can put the payload you want to send to Atlassian Jira Cloud into payload property in the data. Here is an example of the Possible Response after Creation. Atlassian Jira Cloud connector screenshot 5 Alumio will send an API request to Atlassian Jira Cloud with URL /rest/api/3/user **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Atlassian Jira Cloud. # Atlassian Jira Server Source: https://docs.alumio.com/connectors/atlassian-jira-server Connect Alumio to Atlassian Jira Server. ## Extra information System documentation: ## Atlassian Jira Server ## Connector Package Documentation # Setting up HTTP Client Atlassian Jira Server ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Atlassian Jira Server HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI and Authentication Type * Basic * Fill in Username and Password (Replace Password with API Token). * PATs * Fill in the Bearer Token 3. Save. # Subscribing to Entities from Atlassian Jira Server ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Atlassian Jira Server Subscriber as the subscriber. 2. Select the entity you want to subscribe from Atlassian Jira Server. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Atlassian Jira Server HTTP Client to use. ## General Concept We follow Atlassian Jira Server documentation on building this connector so you can easily use the connector based on Atlassian Jira Server API Reference. **Entity** It’s the entity you want to subscribe to from Atlassian Jira Server. Please refer to the entities in Management APIs from the Atlassian Jira Server API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Atlassian Jira Server API Reference. Please look at the example below on how to fill the Request Parameters field when calling “Get project category by id” entity Atlassian Jira Server connector screenshot 1 Atlassian Jira Server connector screenshot 2 That’s why we need to define the **id** property inside the **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get project category by id. /rest/api/2/projectCategory/abc **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Atlassian Jira Server. # Publishing Entity to Atlassian Jira Server ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Atlassian Jira Server Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Atlassian Jira Server entity you want the data to be published. 4. Select the HTTP Client to use. Atlassian Jira Server connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently, we support Create (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Atlassian Jira Server endpoints. Please refer to the entities in Management APIs from the Atlassian Jira Server API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create project category. Please select “Post” as the action and “Create project category” as the entity of the publisher. Atlassian Jira Server connector screenshot 4 Atlassian Jira Server connector screenshot 5 You can put the payload you want to send to Atlassian Jira Server into the payload property in the data, Here's the Example of payload and response. Atlassian Jira Server connector screenshot 6 Alumio will send an API request to Atlassian Jira Server with URL /rest/api/2/projectCategory **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Atlassian Jira Server. # Auth0 Source: https://docs.alumio.com/connectors/auth0 Connect Alumio to Auth0. ## Extra information System documentation: [Auth0 API Reference](https://auth0.com/docs/api/management/v2) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Auth0 * **1.1** Steps * **2.** Subscribing to entities from Auth0 * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Auth0 * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Auth0 **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Auth0 HTTP Client as PlatForm and click next step 3. Fill in the Base URI, Client ID, Client Secret, Scopes and Audience. 4. Click on "Grant access to Auth0" and you will get the key for the client. 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. Auth0 connector screenshot 1 ### 2. Subscribing to Entities from Auth0 **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Auth0 Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from Auth0. 3. Add any request parameters needed to subscribe to the entity. 4. Select the Auth0 HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from Auth0. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Auth0 documentation on building this connector, so you can easily use the connector based on [Auth0 API Reference](https://auth0.com/docs/api/management/v2). **Entity** The entity you want to subscribe to Auth0. Please refer to the entities from [Auth0 API Reference](https://auth0.com/docs/api/management/v2) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Auth0 API Reference](https://auth0.com/docs/api/management/v2). Please look at the example below on how to fill path field when we want retrieve details of a client by subscribing ["Clients - Get client by ID"](https://auth0.com/docs/api/management/v2/clients/get-clients-by-id) entity. Auth0 connector screenshot 2 Auth0 connector screenshot 3 From the end point, we can see that we need to set the client id as parameters. That is why we set the "id" inside the path key in the Request Parameters. Alumio will then make a request to Auth0 with the URL `/api/v2/clients/fcIhGma68utXY5tWMcfgSWyOjzEeyBLm` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access Auth0. ### 3. Publishing Entity to Auth0 **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Auth0 Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the Auth0 entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method and HTTP Delete method on submitting data to Auth0. **Entity** We support publishing to most Auth0 endpoints. Please refer to [Auth0 API Reference](https://auth0.com/docs/api/management/v2) page. For example, we want to create a user. Please select “Post” as the Method and ["Users - Create a User"](https://auth0.com/docs/api/management/v2/users/post-users). Auth0 connector screenshot 4 Auth0 connector screenshot 5 From the documentation, we can see that we need to set a body parameters. That is why we set the body parameters inside the payload key in the data. Auth0 connector screenshot 6 Alumio will send an API request to Auth0 with URL `/api/v2/users` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Auth0. # Basecamp Source: https://docs.alumio.com/connectors/basecamp Connect Alumio to Basecamp. ## Extra information System documentation: ## Connector package documentation # Setting up HTTP Client Basecamp 4 ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Basecamp 4 HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Client ID, and Client Secret. 3. Press “Grant Access to Basecamp 4 ”. 4. Press Save Button on Top-Right. # Subscribing to Entities from Basecamp 4 ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Basecamp 4 Subscriber as the subscriber. 2. Select the Entity you want to subscribe from Basecamp 4. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Shipstation HTTP Client to use. ## General Concept We follow Basecamp 4 documentation on building this connector so you can easily use the connector based on Basecamp 4 API Reference. **Entity** It’s the entity you want to subscribe from Basecamp 4. Please refer to the entities in Management APIs from Basecamp 4 API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Basecamp 4 API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity Basecamp connector screenshot 1 Basecamp connector screenshot 2 That’s why we need to define the **id1** property inside **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such a Request Parameters field. (For more examples on how we define the path parameters please see extra Notes below). /projects/123 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Basecamp 4. # Publishing Entity to Basecamp 4 ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration and select Basecamp 4 Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Basecamp 4 entity you want the data to be published to. 4. Select the HTTP Client to use. Basecamp connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Method** Currently we support Post, Put, and Delete methods for submitting data to Basecamp 4 Cloud API. **Entity** We support publishing to most Basecamp 4 endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Basecamp 4 API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a Project. Please select “POST” as the action and “Create a Project” as the entity of the publisher. Basecamp connector screenshot 4 Basecamp connector screenshot 5 You can put the payload you want to send to Basecamp 4 into payload property in the data. Here is an example of the Possible Response after Creation. Basecamp connector screenshot 6 Alumio will send an API request to Basecamp 4 with URL /projects.json **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Basecamp 4. # Extra Notes **Endpoint Decision** For the Path in the Endpoint the name of the ID is undecided in Documentation This is from the Documentation : `/buckets/1/chats/2.json` This is what i implement on Endpoint : `"/buckets/{{id1}}/chats/{{id2}}.json"` This also implemented in the Random Number Generated on Docs `/buckets/1/card_tables/lists/3/cards.json` Implemented : `"/buckets/{{id1}}/card_tables/lists/{{id2}}/cards.json"` This works for every endpoint that has a random number in the endpoint `/buckets/1/card_tables/lists/3/cards.json` So if the Endpoints are like this `/buckets/1/3/1/3/cards.json` Implemented : `/buckets/{{id1}}/{{id2}}/{{id3}}/{{id4}}/cards.json` # BigCartel Source: https://docs.alumio.com/connectors/bigcartel Connect Alumio to BigCartel. ## Extra information System documentation: \[BigCartel API Reference] **BigCartel** **Connector Package Documentation** # Setting up HTTP Client BigCartel ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select BigCartel HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, Username, and Password. * Save the Client for use later. # Subscribing to Entities from BigCartel ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select BigCartel Subscriber as the subscriber. * Select the entity you want to subscribe from BigCartel . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the BigCartel HTTP Client to use. ## General Concept We follow BigCartel documentation on building this connector so you can easily use the connector based on BigCartel API Reference. **Entity** It’s the entity you want to subscribe from BigCartel . Please refer to the entities in Management APIs from BigCartel API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on BigCartel API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get all products. BigCartel connector screenshot 1 BigCartel connector screenshot 2 That’s why we need to define the **account\_id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get all products. /v1/accounts/Alumio/products **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access BigCartel . # Publishing Entity to BigCartel ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select BigCartel Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the BigCartel entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to BigCartel . * Select the HTTP Client to use. BigCartel connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most BigCartel endpoints. Please refer to the entities in Management APIs from the BigCartel API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a new cateogry. Please select “Post” as the action and “Create a cateogry” as the entity of the publisher. BigCartel connector screenshot 4 BigCartel connector screenshot 5 You can put the payload you want to send to BigCartel into the payload property in the data. Alumio will send an API request to BigCartel with URL /v1/accounts/Alumio/categories **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access BigCartel . # BigCommerce Source: https://docs.alumio.com/connectors/bigcommerce Connect Alumio to BigCommerce. ## Extra information System documentation: [https://developer.bigcommerce.com/api-reference/239aeabf5a786-storefront-carts#management-apis](https://developer.bigcommerce.com/api-reference/239aeabf5a786-storefront-carts#management-apis) ## Connector package documentation ### Table of Contents * **1.** Setting up the BigCommerce HTTP Client * **1.1** Steps * **2.** Subscribing to entities from BigCommerce * **2.1** Steps * **2.2** General concept * **3.** Publishing entities to BigCommerce * **3.1** Steps * **3.2** General concept ### 1. Setting up the BigCommerce HTTP Client **1.1 Steps** 1. Go to the API Accounts page in BigCommerce Control Panel (Advanced Settings -> API Accounts) and create a new API Account. 2. Select the scopes you need and save them. 3. You will get a file downloaded from the page containing the Base URI and Access Token to be used to configure the HTTP Client in your Alumio Dashboard. 4. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select BigCommerce Client as the prototype of the HTTP Client. 5. Fill in the Base URI and Access Token with the values from the downloaded file when creating an API Account in the BigCommerce Control Panel. We recommend putting the Base URI and Access Token as Alumio Environment Variables and using the variables instead of directly filling the values in the BigCommerce HTTP Client form. BigCommerce connector screenshot 1 ### 2. Subscribing to Entities from BigCommerce **2.1 Steps** 1. Go to Connections -> Incoming, create a new incoming configuration, and select BigCommerce – Entity Subscriber as the subscriber. 2. Select the entity you want to subscribe to from BigCommerce. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can add a transformer to manipulate the request parameters into something you need. 5. Select the BigCommerce HTTP Client to use. 6. You can add a pagination feature to allow Alumio to fetch a paginated entity. BigCommerce connector screenshot 2 **2.2 General Concept** We follow BigCommerce documentation on building this connector, so you can easily use the connector based on BigCommerce API Reference. **Entity** This is the entity you want to subscribe to from BigCommerce. Please refer to the entities in Management APIs from the BigCommerce API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the BigCommerce API reference. Please look at the example below on how to fill the Request Parameters field when subscribing to the "Product Images" entity. BigCommerce connector screenshot 3 * Path is the path parameter of the URL. For example the \{id}. * Query is a defined set of parameters attached to the end of a URL.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) This means that we want to subscribe to product images of a product with ID 111, and we only want to fetch the url\_standard and url\_thumbnail of every image. We can see in the documentation that the product images entity requires product\_id as a path parameter to define which product we want to fetch the images from. BigCommerce connector screenshot 4 That’s why we need to define the product\_id property inside the path key in the Request Parameters field. The properties inside query parameters (in this example, would be include\_fields, page, and limit) will be parsed as query parameters. The final URL that Alumio requested is /v3/catalog/products/111/images?page=1\&limit=3\&include\_fields=url\_standard%2Curl\_thumbnail **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** This is the HTTP Client configuration or prototype you will use to access BigCommerce. **Follow Pagination** We can configure Alumio to be able to fetch a paginated entity from BigCommerce in a single run of the incoming configuration. In order to do a pagination for a BigCommerce entity within Alumio, you need to fill the “Pattern to Items” with “data” because BigCommerce wraps the data returned inside the “data” property. And then, please select “Increase query parameter” as the “Follow Pagination” method. Please have a look at the picture below. BigCommerce connector screenshot 5 The above configuration will allow Alumio to fetch a maximum of 100 pages of the entity with 100 entities per page. When Alumio has fetched the 100th page, Alumio will stop and track the pagination progress in the Storage, which you can select “Storage to track progress”. In the next run of the incoming configuration, Alumio will continue the pagination process if you select the storage. ### 3. Publishing Entities to BigCommerce **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select BigCommerce – Entity Publisher as the publisher. 2. Select the action you want the publisher to do with the data. 3. Select the BigCommerce entity where you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can add transformers to manipulate the data into anything you need before submitting it to BigCommerce. 6. Select the HTTP Client to use. BigCommerce connector screenshot 6 **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in the outgoing configuration). However, you can also add or modify the payload using a Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method) entities. **Entity** We support publishing to most BigCommerce endpoints but not publishing binary files at the moment. Please refer to the entities in Management APIs from the BigCommerce API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to update an image of a specific product. Please select “Update” as the action and “Product Image by Product ID and Image ID” as the entity of the publisher. BigCommerce connector screenshot 7 The documentation says that we need product\_id and image\_id as path parameters. In that case, you need to provide product\_id and image\_id properties into the path property in the data, either as an output from Routes or output from Transformers in the Outgoing Configuration. And you can put the payload you want to send to BigCommerce into the payload key in the data. Here is an example of the required data. BigCommerce connector screenshot 8 Alumio will send an API request to BigCommerce with URL /v3/catalog/products/111/images/371, and the body will be like this: BigCommerce connector screenshot 9 For endpoints that require us to put query parameters into the URL, i.e., Delete Brands, you can just put the query into the query property in the data like this: BigCommerce connector screenshot 10 * Path is the path parameter of the URL. For example, the \{id}. * Query is a defined set of parameters attached to the end of a URL.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. Alumio will send an API request to BigCommerce with URL /v3/catalog/brands?name=Brand%20X **HTTP Client** This is the HTTP Client configuration or prototype you will use to access BigCommerce. # BigCommerce B2B Source: https://docs.alumio.com/connectors/bigcommerce-b2b Connect Alumio to BigCommerce B2B. ## Extra information Connector package documentation: System documentation: # Setting up HTTP Client Bigcommerce Bundle B2B ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Bigcommerce Bundle B2B HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI (Recommend: [https://api.bundleb2b.net](https://api.bundleb2b.net)), Store Hash, Email, Password, Name, BeginAt, EndAt, and ChannelID. # Subscribing to Entities from Bigcommerce Bundle B2B ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Bigcommerce Bundle B2B Subscriber as the subscriber. 2. Select the entity you want to subscribe to from Bigcommerce Bundle B2B. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Bigcommerce Bundle B2B HTTP Client to use. ## General Concept We follow Bigcommerce Bundle B2B documentation on building this connector so you can easily use the connector based on Bigcommerce Bundle B2B API Reference. **Entity** It’s the entity you want to subscribe from Bigcommerce Bundle B2B. Please refer to the entities in Management APIs from the Bigcommerce Bundle B2B API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Bigcommerce Bundle B2B API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get a User entity BigCommerce B2B connector screenshot 1 BigCommerce B2B connector screenshot 2 That’s why we need to define the **userId** property inside the **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the Get a user entity. /api/v3/io/users/123 **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Bigcommerce Bundle B2B. # Publishing Entity to Bigcommerce Bundle B2B ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Bigcommerce Bundle B2B Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Bigcommerce Bundle B2B entity you want the data to be published. 4. Select the HTTP Client to use. BigCommerce B2B connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Bigcommerce Bundle B2B endpoints. Please refer to the entities in Management APIs from the Bigcommerce Bundle B2B API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Delete a User. Please select “Delete” as the action and “Delete a User” as the entity of the publisher. BigCommerce B2B connector screenshot 4 BigCommerce B2B connector screenshot 5 You can put the payload you want to send to Bigcommerce Bundle B2B into the payload property in the data. Here is an example of the Possible Response after Creation. BigCommerce B2B connector screenshot 6 Alumio will send an API request to Bigcommerce Bundle B2B with the URL /api/v3/io/users/123 **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Bigcommerce Bundle B2B. # BigQuery Source: https://docs.alumio.com/connectors/bigquery Connect Alumio to BigQuery. ## Extra information System documentation: [BigQuery API Reference](https://cloud.google.com/bigquery/docs/reference) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client BigQuery * **1.1** Steps * **2.** Subscribing to entities from BigQuery * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to BigQuery * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client BigQuery **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select BigQuery HTTP Client as Platform and click Next Step 3. Fill in the Base URI and then select OAuth 2 for the Authentication type or Bearer for the alternative. 4. Fill in the Client ID and the Client Secret (See the [BigQuery Authentication Documentation](https://cloud.google.com/bigquery/docs/reference/rest) for more information) 5. You can optionally enable logging of requests to get the log of the authentication. 6. Click next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use. ### 2. Subscribing to Entities from BigQuery **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "BigQuery Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from BigQuery. 3. Add any request parameters needed to subscribe to the entity. 4. Select the BigQuery HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from BigQuery. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **2.2 General Concept** We follow BigQuery documentation on building this connector, so you can easily use the connector based on [BigQuery API Reference](https://cloud.google.com/bigquery/docs/reference/rest). **Entity** The entity you want to subscribe to BigQuery. Please refer to the entities from [BigQuery API Reference](https://cloud.google.com/bigquery/docs/reference/rest) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [BigQuery API Reference](https://cloud.google.com/bigquery/docs/reference/rest). Please look at the example below on how to fill request parameters when we want to run a BigQuery SQL query synchronously and return query results [(Queries)](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query). BigQuery connector screenshot 1 BigQuery connector screenshot 2 From the endpoint, we can see that we need to set the "query" as a payload. Alumio will then make a POST request to BigQuery with the URL `/queries` * Path is the path parameter of the URL. For example, the \{id}. * A query is defined set of parameters attached to the end of a URL.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access BigQuery. **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "BigQuery Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the BigQuery entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify the payload using the Request Transformer. **Method** Currently, we support the POST method, PUT, PATCH method, and DELETE method for submitting data to BigQuery. **Entity** We support publishing to all BigQuery endpoints. Please refer to [BigQuery API Reference](https://cloud.google.com/bigquery/docs/reference/rest) page. For example, we want to patch the dataset information. Please select “Patch” as the Method and ["Patch Dataset"](https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/patch). BigQuery connector screenshot 3 BigQuery connector screenshot 4 From the documentation, we can see that we need to set a path for "datasetId" and body parameters. That is why we set the "datasetId" inside the path key and the body parameters inside the payload key in the data. BigQuery connector screenshot 5 Alumio will send an API request to BigQuery with URL `/dataset/_datasetId12334545465` * Path is the path parameter of the URL. For example, the \{id}. * A query isa defined set of parameters attached to the end of a URL.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access BigQuery. # Bitrix24 Source: https://docs.alumio.com/connectors/bitrix24 Connect Alumio to Bitrix24. ## Extra information System documentation: [Bitrix24 API Reference](https://training.bitrix24.com/rest_help/index.php) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Bitrix24 * **1.1** Steps * **2.** Subscribing to entities from Bitrix24 * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Bitrix24 * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Bitrix24 **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select "Bitrix24 HTTP Client" as the HTTP Client. 2. Fill in the Base URI, Client ID, Client Secret, and Scopes (Optional). (For more information, see [Bitrix24 Authentication Reference](https://training.bitrix24.com/rest_help/oauth/authentication.php)) 3. Click on "Grant access to Bitrix24" to get the Key. 4. You can optionally enable logging of request to get the log of the authentication. 5. Save the HTTP Client for use. Bitrix24 connector screenshot 1 ### 2. Subscribing to Entities from Bitrix24 **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Bitrix24 Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from Bitrix24. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you will request from Bitrix24. 5. You can also optionally enable pagination to allow Alumio fetches paginated entities. 6. Select the Bitrix24 HTTP Client to use. **2.2 General Concept** We follow Bitrix24 documentation on building this connector, so you can easily use the connector based on [Bitrix24 API Reference](https://training.bitrix24.com/rest_help/index.php). **Entity** The entity you want to subscribe to Bitrix24. Please refer to the entities from [Bitrix24 API Reference](https://training.bitrix24.com/rest_help/index.php) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Bitrix24 API Reference](https://training.bitrix24.com/rest_help/index.php). Please look at the example below on how to fill path field when subscribing ["Sale Order Get"](https://training.bitrix24.com/rest_help/sale/order/sale_order_get.php) entity. Bitrix24 connector screenshot 2 Bitrix24 connector screenshot 3 Based on the documentation, we can see that the end point require "id" as a parameter. That is why we set the "id" inside the payload key in the Request Parameters. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. Alumio will then make a request to Bitrix24 with the URL /rest/sale.order.get.json **HTTP Client** The HTTP Client configuration you will use to access Bitrix24. ### 3. Publishing Entity to Bitrix24 **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Bitrix24 Publisher" as the publisher. 2. Select the Action that you want the publisher to perform with the data. 3. Select the Bitrix24 entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method) and Delete (HTTP DELETE method) on submitting data to Bitrix24. **Entity** We support publishing to most Bitrix24 endpoints. Please refer to [Bitrix24 API Reference](https://training.bitrix24.com/rest_help/index.php) page. For example, we want to add a new sale paysystem. Please select “Create” as the Action and ["Sale Paysystem Add"](https://training.bitrix24.com/rest_help/crm/sale/sale_paysystem_add.php) as the entity of the publisher. Bitrix24 connector screenshot 4 Bitrix24 connector screenshot 5 Based on the documentation, we need to add fields. So we put the fields inside the payload key in the Data. Bitrix24 connector screenshot 6 Alumio will send an API request to Bitrix24 with URL /sale.paysystem.add.json * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Bitrix24. # BlueSnap Source: https://docs.alumio.com/connectors/bluesnap Connect Alumio to BlueSnap. ## Extra information System documentation: \[BlueSnap API Reference] **BlueSnap** **Connector Package Documentation** # Setting up HTTP Client BlueSnap ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select BlueSnap HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, Username, and Password. * Save the Client for use later. # Subscribing to Entities from BlueSnap ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select BlueSnap Subscriber as the subscriber. * Select the entity you want to subscribe from BlueSnap . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the BlueSnap HTTP Client to use. ## General Concept We follow BlueSnap documentation on building this connector so you can easily use the connector based on BlueSnap API Reference. **Method** It’s the Method you want to subscribe from BlueSnap. Based on the Method, the Entity will change. Please refer to the entities in Management APIs from BlueSnap API Reference page. **Entity** It’s the entity you want to subscribe from BlueSnap . Please refer to the entities in Management APIs from BlueSnap API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on BlueSnap API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Retrieve Vendor. BlueSnap connector screenshot 1 BlueSnap connector screenshot 2 That’s why we need to define the **vendorId** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Retrieve Vendor. /services/2/vendors/20231512057123123 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access BlueSnap . # Publishing Entity to BlueSnap ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select BlueSnap Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the BlueSnap entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to BlueSnap . * Select the HTTP Client to use. BlueSnap connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most BlueSnap endpoints. Please refer to the entities in Management APIs from the BlueSnap API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create Vendor. Please select “Post” as the action and “Create Vendor” as the entity of the publisher. BlueSnap connector screenshot 4 BlueSnap connector screenshot 5 You can put the payload you want to send to BlueSnap into the payload property in the data. Alumio will send an API request to BlueSnap with URL /services/2/vendors **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access BlueSnap . # Bol.com Source: https://docs.alumio.com/connectors/bol-com Connect Alumio to Bol.com. ## Extra information System documentation: [https://api.bol.com/retailer/public/Retailer-API/index.html](https://api.bol.com/retailer/public/Retailer-API/index.html) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Bol.com * **1.1** Steps * **2.** Subscribing to entities from Bol.com * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Bol.com * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Bol.com **1.1 Steps** 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Bol.com v9 HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Token URI, Client Type, Client id, and Client Secret. 3. You can optionally enable logging of requests to get the log of the authentication. 4. Click on Grant access to Bol.com to get the Key. 5. Save the HTTP Client after the key has been provided. Bol.com connector screenshot 1 ### 2. Subscribing to Entities from Bol.com **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select Bol.com v9 Advertiser Subscriber, Bol.com Retailer v9 Subscriber, or Bol.com v9 Shared Subscriber as the subscriber. Bol.com connector screenshot 2 2. Select the entity you want to subscribe to from Bol.com. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Bol.com HTTP Client to use. (Please set the Client Type according to what you need for the Subscriber) **2.2 General Concept** We follow Bol.com documentation on building this connector so you can easily use the connector based on Bol.com API Reference. **Entity** It’s the entity you want to subscribe from Bol.com. Please refer to the entities in Management APIs from Bol.com API Reference. **Request Parameters** These are the parameters you can provide to get the needed entity based on Bol.com API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing ["Retrieve an offer by its offer id"](https://api.bol.com/retailer/public/redoc/v9/retailer.html#tag/Offers/operation/get-offer). Bol.com connector screenshot 3 Bol.com connector screenshot 4 Because the offer id is inside path, we put it like that. This will be sent to the Bol system as /retailer/offers/6a3ef7aa-d1b8-4eaf-9fe9-7260ccc08281 * Path is the path parameter of the url. For example, the \{id}. * Query is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) **Input Transformer** Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration you will use to access Bol.com. (Please set the Client Type according to what you need for the Subscriber) ### 3. Publishing Entity to Bol.com **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Bol.com v9 Advertiser Publisher or Bol.com v9 Retailer Publisher as the publisher. Bol.com connector screenshot 5 2. Select the action that you want the publisher to do with the data currently Bol.com support Create, Update, and Delete. 3. Select the Bol.com entity you want the data to be published. 4. Select the HTTP Client to use. (Please set the Client Type according to what you need for the Publisher) **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Bol.com endpoints. Please refer to the entities in Management APIs from the Bol.com API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Thread. Please select “CREATE” as the action and [“ Create content for a product”](https://api.bol.com/retailer/public/redoc/v9/retailer.html#tag/Product-Content/operation/post-product-content) as the entity of the publisher. Bol.com connector screenshot 6 Bol.com connector screenshot 7 Based on the documentation, we need to add a Body Request. So we put the body inside the payload key in the Data. Bol.com connector screenshot 8 Alumio will send an API request to Bol.com with the URL /retailer/content/products Another example is when we want to delete an offer. Bol.com connector screenshot 9 Bol.com connector screenshot 10 We can see in the documentation that we need to add "offer-id" in the path; we need to add them in our data, for example: Bol.com connector screenshot 11 * Path is the path parameter of the url. For example, the \{id}. * Query is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** It’s the HTTP Client configuration you will use to access Bol.com. (Please set the Client Type according to what you need for the Publisher) # Brightpearl Source: https://docs.alumio.com/connectors/brightpearl Connect Alumio to Brightpearl. ## Extra information System documentation: [Brightpearl API Reference](https://api-docs.brightpearl.com/) ## Connector package documentation **Brightpearl** # Setting up HTTP Client Brightpearl ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Brightpearl HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Application Reference and Token. 3. Save the Client for use later. # Subscribing to Entities from Brightpearl ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Brightpearl Subscriber as the subscriber. 2. Select the entity you want to subscribe from Brightpearl. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Brightpearl HTTP Client to use. ## General Concept We follow Brightpearl documentation on building this connector so you can easily use the connector based on Brightpearl API Reference. **Entity** It’s the entity you want to subscribe from Brightpearl. Please refer to the entities in Management APIs from Brightpearl API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Brightpearl API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Product entity Brightpearl connector screenshot 1 Brightpearl connector screenshot 2 That’s why we need to define the **ID-SET** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Product. /product-service/product/126274 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Brightpearl. # Publishing Entity to Brightpearl ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Brightpearl Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Brightpearl entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Brightpearl. 6. Select the HTTP Client to use. Brightpearl connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Brightpearl endpoints. Please refer to the entities in Management APIs from the Brightpearl API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create Product. Please select “Post” as the action and “Product” as the entity of the publisher. Brightpearl connector screenshot 4 Brightpearl connector screenshot 5 You can put the payload you want to send to Brightpearl into the payload property in the data. Alumio will send an API request to Brightpearl with URL /product-service/product **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Brightpearl. # Caflou Source: https://docs.alumio.com/connectors/caflou Connect Alumio to Caflou. ## Extra information System documentation: ## Connector package documentation **Caflou** # Setting up HTTP Client Caflou ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Caflou HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Authentication type. * Request, Fill in the Username and Password * Token, Fill in the Token. 3. Save the Client for use later. # Setting up Credentials ## Steps 1. Token * On the Dashboard, click on top right gear icon (setting icon) * Go to Account settings > API * Click Add Token then set the name and validity date. * Copy the Token to use 2. Request * Simply Register to the environment and use the same username and password that used to login into Freshdesk # Subscribing to Entities from Caflou ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Caflou Subscriber as the subscriber. 2. Select the entity you want to subscribe from Caflou. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Caflou HTTP Client to use. ## General Concept We follow Caflou documentation on building this connector so you can easily use the connector based on Caflou API Reference. **Entity** It’s the entity you want to subscribe from Caflou. Please refer to the entities in Management APIs from Caflou API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Caflou API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Products - Get entity Caflou connector screenshot 1 Caflou connector screenshot 2 That’s why we need to define the **id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Products - Get. /products/AB2SC **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Caflou. # Publishing Entity to Caflou ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Caflou Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Caflou entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Caflou. 6. Select the HTTP Client to use. Caflou connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Post (HTTP POST method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Caflou endpoints. Please refer to the entities in Management APIs from the Caflou API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Delete Project. Please select “Delete” as the action and “Projects - Delete” as the entity of the publisher. Caflou connector screenshot 4 Caflou connector screenshot 5 You can put the payload you want to send to Caflou into the payload property in the data. Alumio will send an API request to Caflou with URL /projects/AB2SC **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Caflou. # Catch of the Day Source: https://docs.alumio.com/connectors/catch-of-the-day Connect Alumio to Catch of the Day. ## Extra information System documentation: ## Connector package documentation **Catch of the day** # Setting up HTTP Client Catch of the day ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Catch of the day HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, and API Key. 3. Save the Client for use later. # Subscribing to Entities from Catch of the day ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Catch of the day Subscriber as the subscriber. 2. Select the entity you want to subscribe from Catch of the day. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Catch of the day HTTP Client to use. ## General Concept We follow Catch of the day documentation on building this connector so you can easily use the connector based on Catch of the day API Reference. **Entity** It’s the entity you want to subscribe from Catch of the day. Please refer to the entities in Management APIs from Catch of the day API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Catch of the day API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Retrieve a thread entity. Catch of the Day connector screenshot 1 Catch of the Day connector screenshot 2 That’s why we need to define the **thread\_id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Retrieve a thread. /api/inbox/threads/123bact **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Catch of the day. # Publishing Entity to Catch of the day ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Catch of the day Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Catch of the day entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Catch of the day. 6. Select the HTTP Client to use. Catch of the Day connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Catch of the day endpoints. Please refer to the entities in Management APIs from the Catch of the day API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create offer. Please select “Post” as the action and “Create, update, or delete offers” as the entity of the publisher. Catch of the Day connector screenshot 4 Catch of the Day connector screenshot 5 You can put the payload you want to send to Catch of the day into the payload property in the data. Alumio will send an API request to Catch of the day with URL /api/offers **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Catch of the day. # Centra Source: https://docs.alumio.com/connectors/centra Connect Alumio to Centra. ## Extra information System documentation: [Centra API Reference](https://centra.dev/docs/integration-api/what-you-can-do-with-it) # Setting up Centra GraphQL Client ## Steps * In Alumio Dashboard, go to Clients > HTTP Client. Create a new HTTP Client and select Centra GraphQL Client as the prototype of the HTTP Client. Centra connector screenshot 1 * Fill in the Base URI and API Token. * Enable the logging if needed. * Save and Continue. # Subscribing to Entities from Centra GraphQL ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Centra - GraphQL Subscriber as the subscriber. * Add any Request URI that you need to add from the Base URI from Client. * Select the HTTP Method you want to subscribe to from Centra GraphQL (The default is POST). * Add any request data in the request parameter that you needed to subscribe to the entity. * You can optionally add a transformer to transform the request parameters into something you need. * Select the Centra GraphQL Client to use. ## General Concept We follow Centra GraphQL documentation on building this connector so you can easily use the connector based on Centra GraphQL API Reference. **Request URI** It’s the Endpoint you want to subscribe from Centra. **Request Method** It’s the HTTP Method that you want to use, we recommend using post as default method. **Request Parameters** These are the parameters you can provide to get the needed entity based on Centra GraphQL API Reference. Please look at the example below on how to fill the Request Parameters field when trying to fetch products using some query parameter. Centra connector screenshot 2 **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Centra GraphQL. # Publishing Entity to Centra GraphQL ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Centra Publisher as the publisher. * Select the Request URI you want the data to be published. * Select the Request Method that you want the publisher to do with the data. * Add any request data in the request parameter that you needed to subscribe to the entity. * Select the HTTP Client to use. ## General Concept Like the subscriber, the publisher has similar methods on how to use it. **Request Parameters** Please refer to the entities in Management APIs from the Centra GraphQL API Reference page. Please look at the example below. For example, we want to confirm an order with number 3957. Centra connector screenshot 3 You can put the payload you want to send to Centra GraphQL into the Request Parameters . **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Centra GraphQL. # Channable Source: https://docs.alumio.com/connectors/channable Connect Alumio to Channable. ## Extra information System documentation: [Channable API Reference](https://api.channable.com/v1/docs#section/Introduction) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Channable * **1.1** Steps * **2.** Subscribing to entities from Channable * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Channable * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Channable **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select the Channable Client as the HTTP Client. 2. Fill in the Base URI, and Bearer Token according to your Channable account. For more information, see [Channable Getting Started](https://api.channable.com/v1/docs#section/Introduction/Getting-started) 3. You can optionally enable logging to get the log of the request. 4. Save the HTTP Client for use. Channable connector screenshot 1 ### 2. Subscribing to Entities from Channable **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select Channable Subscriber as the subscriber. 2. Select the Channable HTTP Client to use. 3. Select the entity you want to subscribe to from Channable. 4. You can optionally change the logging to be different with the HTTP Client. 5. Add any request parameters needed to subscribe to the entity. Please refer to an example in the General Concept section. 6. You can optionally add a transformer to transform the request parameters before making a request to Channable. Channable connector screenshot 2 **2.2 General Concept** We follow Channable documentation for building this connector, which means you can easily use the connector based on the [Channable API Reference](https://api.channable.com/v1/docs#section/Introduction). **Entity** The entity you want to subscribe to Channable. Please refer to the entities from th [Channable API Reference](https://api.channable.com/v1/docs#section/Introduction) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Channable API Reference](https://api.channable.com/v1/docs#section/Introduction). Please look at the example below on how to fill the Request Parameters field when subscribing to the [Channels For Transporter](https://api.channable.com/v1/docs#tag/transporters/operation/channels_for_transporter_transporters_transporter__transporter_code__get) entity. We can see in the documentation that there are some parameter values in the path URL such as transporter\_code. Channable connector screenshot 3 We set the Request Parameter as an example below: Channable connector screenshot 4 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then send it to Channable as /v1/transporters/transporter/DHL **Input Transformer** Any transformers that are set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as the query parameters of an entity. **HTTP Client** The HTTP Client configuration you will use to access Channable. ### 3. Publishing Entity to Channable **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select the Channable Publisher as the publisher. 2. Select the HTTP Client to use. 3. Select the Channable entity you want the data to be published to. 4. You can optionally change the logging to be different with the HTTP Client. 5. You can optionally add any path data to the request on the key path or change them in the Advanced Tab. 6. You can optionally add any query data to the request on the key query or change them in the Advanced Tab. 7. You can optionally add any payload data to the request on the key payload or change them in the Advanced Tab. Channable connector screenshot 5 **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently we support POST method on submitting data to Channable. **Entity** We support publishing to most Channable endpoints. Please refer to [Channable API Reference](https://api.channable.com/v1/docs#section/Introduction) page. Based on the documentation, some endpoints may need one or more path parameters. For example, we want to update return status. Please select "POST" as the method and ["Update Return Status"](https://api.channable.com/v1/docs#tag/returns/operation/update_return_status_companies__company_id__projects__project_id__returns__return_id__status_post) as the entity of the publisher. Channable connector screenshot 6 The documentation says that we need "return\_id", "company\_id", and "project\_id" as path parameters. In that case, you need to provide "return\_id", "company\_id", and "project\_id" key into the path key in the data, either as an output from Routes or output from Transformers in Outgoing Configuration. And, you can put the payload you want to send to Channable into the payload key in the data. Here is an example of the required data. Channable connector screenshot 7 Alumio will send an API request to Channable with the URL /v1/companies/29370/projects/84767/returns/1/status and the body will be like this. Channable connector screenshot 8 * Path is the path parameter of the url. For example the \{id}. * Query is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Channable. # ChannelEngine Source: https://docs.alumio.com/connectors/channelengine Connect Alumio to ChannelEngine. ## Extra information System documentation: [Channel Engine API Reference](https://demo.channelengine.net/api/swagger/index.html?urls.primaryName=ChannelEngine%20Channel%20API) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Channel Engine * **1.1** Steps * **2.** Subscribing to entities from Channel Engine * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Channel Engine * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Channel Engine **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select "Channel Engine HTTP Client" as the HTTP Client. 2. Fill in the Base URL and API Key. 3. You can optionally enable logging of request to get the log of the authentication. 4. Save the HTTP Client for use. ChannelEngine connector screenshot 1 ### 2. Subscribing to Entities from Channel Engine **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "ChannelEngine - Merchant Subscriber" or "ChannelEngine - Channel Subscriber" as the subscriber. 2. Select the Channel Engine HTTP Client to use. 3. Select the entity you want to subscribe to from Channel Engine. 4. Add any request parameters needed to subscribe to the entity. 5. You can optionally add a transformer to transform the request parameters into something you will request from Channel Engine. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Channel Engine documentation on building this connector, so you can easily use the connector based on [Channel Engine API Reference](https://demo.channelengine.net/api/swagger/index.html?urls.primaryName=ChannelEngine%20Channel%20API). **HTTP Client** The HTTP Client configuration you will use to access Channel Engine. **Entity** The entity you want to subscribe to Channel Engine. Please refer to the entities from [Channel Engine API Reference](https://demo.channelengine.net/api/swagger/index.html?urls.primaryName=ChannelEngine%20Channel%20API) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Channel Engine API Reference](https://demo.channelengine.net/api/swagger/index.html?urls.primaryName=ChannelEngine%20Channel%20API). Please look at the example below on how to fill path field when subscribing "Download Invoice" entity. ChannelEngine connector screenshot 2 ChannelEngine connector screenshot 3 Based on the documentation, we can see that the end point require "merchantOrderNo" as a path. That is why we set the "merchantOrderNo" inside the path key in the Request Parameters. * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then make a request to Channel Engine with the URL /v2/orders/123/invoice ### 3. Publishing Entity to Channel Engine **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "ChannelEngine - Merchant Publisher" or "ChannelEngine - Channel Publisher" as the publisher. 2. Select the Action that you want the publisher to perform with the data. 3. Select the Channel Engine entity you want the data to be published to. 4. You can optionally add any path data to the request on the key path. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. 7. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support HTTP POST method, HTTP PUT method and HTTP DELETE method on submitting data to Channel Engine. **Entity** We support publishing to most Channel Engine endpoints. Please refer to [Channel Engine API Reference](https://demo.channelengine.net/api/swagger/index.html?urls.primaryName=ChannelEngine%20Channel%20API) page. For example, we want to use delete a product. Please select “DELETE” as the Action and "Delete Product" as the entity of the publisher. ChannelEngine connector screenshot 4 ChannelEngine connector screenshot 5 Based on the documentation, we can see that the end point require "merchantOrderNo" as a path. That is why we set the "merchantOrderNo" inside the path key in the Data. ChannelEngine connector screenshot 6 Alumio will send an API request to Channel Engine with URL /v2/products/123 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Channel Engine. # Claude by Anthropic Source: https://docs.alumio.com/connectors/claude-by-anthropic Connect Alumio to Claude by Anthropic. ## Extra information System documentation: \[Claude by Anthropic API Reference] **Claude** **Connector Package Documentation** # Setting up HTTP Client Claude ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Claude HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, Api Key, and Anthropic Version (Currently we support 2023-06-01, Please Request the newest version in Alumio Forum ). * Save the Client for use later. # Subscribing to Entities from Claude ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Claude Subscriber as the subscriber. * Select the entity you want to subscribe from Claude . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the Claude HTTP Client to use. ## General Concept We follow Claude documentation on building this connector so you can easily use the connector based on Claude API Reference. **Method** It’s the Method you want to subscribe from Claude. Based on the Method, the Entity will change. Please refer to the entities in Management APIs from Claude API Reference page. **Entity** It’s the entity you want to subscribe from Claude . Please refer to the entities in Management APIs from Claude API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Claude API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Stream – Create a Message. Claude by Anthropic connector screenshot 1 Claude by Anthropic connector screenshot 2 Here is the final URL that will be called when using such Request Parameters field on Create a Message. /v1/messages **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Claude . # Publishing Entity to Claude ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Claude Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the Claude entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to Claude . * Select the HTTP Client to use. Claude by Anthropic connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we only support Post (HTTP POST method). **Entity** We support publishing to most Claude endpoints. Please refer to the entities in Management APIs from the Claude API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Message. Please select “Post” as the action and “Create a Message” as the entity of the publisher. Claude by Anthropic connector screenshot 4 Claude by Anthropic connector screenshot 5 You can put the payload you want to send to Claude into the payload property in the data. Alumio will send an API request to Claude with URL /v1/messages **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Claude . # ClickUp Source: https://docs.alumio.com/connectors/clickup Connect Alumio to ClickUp. ## Extra information System documentation: [ClickUp API Reference](https://clickup.com/api/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client ClickUp * **1.1** Steps * **2.** Subscribing to entities from ClickUp * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to ClickUp * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client ClickUp **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select ClickUp HTTP Client as PlatForm and click next step 3. Fill in the Base URI 4. Select the Authentication Type * Basic Authentication * Fill in the Personal Token (See the [ClickUp Token Authentication Documentation](https://clickup.com/api/developer-portal/authentication/#personal-token) for more information) * Oauth 2.0 Authentication * Fill in the Token URL, Authorize URL, Client ID and Client Secret. * Click on "Grant access to ClickUp" and you will be redirected to ClickUp website to get the key for the client. (See the [ClickUp Oauth 2.0 Authentication Documentation](https://clickup.com/api/developer-portal/authentication/#build-apps-for-others---oauth-flow) 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. ClickUp connector screenshot 1 ### 2. Subscribing to Entities from ClickUp **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "ClickUp Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from ClickUp. 3. Add any request parameters needed to subscribe to the entity. 4. Select the ClickUp HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from ClickUp. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow ClickUp documentation on building this connector, so you can easily use the connector based on [ClickUp API Reference](https://clickup.com/api/). **Entity** The entity you want to subscribe to ClickUp. Please refer to the entities from [ClickUp 2.0 API Reference](https://clickup.com/api/) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [ClickUp API Reference](https://clickup.com/api/). Please look at the example below on how to fill path field when we want retrieve list of task by subscribing ["Tasks - Get Tasks"](https://clickup.com/api/clickupreference/operation/GetTasks/) entity. ClickUp connector screenshot 2 ClickUp connector screenshot 3 From the end point, we can see that we need to set the list id as parameters. That is why we set the "list\_id" inside the path key in the Request Parameters. Alumio will then make a request to ClickUp with the URL `/v2/list/901803781168/task` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access ClickUp. **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "ClickUp Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the ClickUp entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to ClickUp. **Entity** We support publishing to all ClickUp 2.0 endpoints. Please refer to [ClickUp API Reference](https://clickup.com/api/) page. For example, we want to update a task. Please select “Put” as the Method and ["Tasks - Update a Task"](https://clickup.com/api/clickupreference/operation/UpdateTask/). ClickUp connector screenshot 4 ClickUp connector screenshot 5 From the documentation, we can see that we need to set a path parameter and a body parameters. That is why we set the "task\_id" inside the path key and body parameters inside the payload key in the data. ClickUp connector screenshot 6 Alumio will send an API request to ClickUp with URL `https://api.clickup.com/api/v2/task/86eqhgatq` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access ClickUp. # Cloudflare Source: https://docs.alumio.com/connectors/cloudflare Connect Alumio to Cloudflare. ## Extra information System documentation: [\[Cloudflare API Reference\]](https://developers.cloudflare.com/api/) **Cloudflare** **Connector Package Documentation** # Setting up HTTP Client Cloudflare ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Cloudflare HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, and Choose the Authentication Type. * Bearer Token : Fill in the Token * Api key (api\_email) : Fill in the X-Auth-Email * Api key (api\_key) : Fill in the X-Auth-Key * Api key (user\_service\_key) : Fill in the X-Auth-User-Service-Key * Save the Client for use later. # Subscribing to Entities from Cloudflare ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Cloudflare Subscriber as the subscriber. * Select the entity you want to subscribe from Cloudflare. * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the Cloudflare HTTP Client to use. ## General Concept We follow Cloudflare documentation on building this connector so you can easily use the connector based on Cloudflare API Reference. **Method** Currently, we support Post (HTTP POST method), and Get (HTTP GET method). **Entity** It’s the entity you want to subscribe from Cloudflare. Please refer to the entities in Management APIs from Cloudflare API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Cloudflare API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get Account Details entity. Cloudflare connector screenshot 1 Cloudflare connector screenshot 2 That’s why we need to define the **account\_id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get Account Details. /client/v4/accounts/Alumio **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Cloudflare. # Publishing Entity to Cloudflare ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Cloudflare Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the Cloudflare entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to Cloudflare. * Select the HTTP Client to use. Cloudflare connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Cloudflare endpoints. Please refer to the entities in Management APIs from the Cloudflare API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Purge Cached Conent of Zone. Please select “Post” as the action and “Zone – Purge All Files” as the entity of the publisher. Cloudflare connector screenshot 4 Cloudflare connector screenshot 5 You can put the payload you want to send to Cloudflare into the payload property in the data. Alumio will send an API request to Cloudflare with URL /client/v4/zones/Alumio/purge\_cache **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Cloudflare. # Cloudsuite Source: https://docs.alumio.com/connectors/cloudsuite Connect Alumio to Cloudsuite. ## Extra information System documentation: [CloudSuite API Reference](https://cloudsuite.atlassian.net/wiki/spaces/CCS/pages/291471404/CloudSuite+API+v1.0+REST) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client CloudSuite * **1.1** Steps * **2.** Subscribing to entities from CloudSuite * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to CloudSuite * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client CloudSuite **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select CloudSuite HTTP Client as the HTTP Client. 2. Fill in the Base URI and choose the Authentication type (Access Token or OAuth 2) (For more information, see [CloudSuite Authentication Reference](https://cloudsuite.atlassian.net/wiki/spaces/CCS/pages/444727395/Usage+Info#Authentication-API)) 3. Fill in the Access token if you choose Access Token for the Authentication type. 4. Fill in the Client ID, Client secret, Token URL, and Scopes if you choose OAuth 2 for the Authentication type. 5. You can optionally enable logging of requests to get the log of the authentication. 6. Save the HTTP Client for use. ### 2. Subscribing to Entities from CloudSuite **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select CloudSuite Subscriber as the subscriber. 2. Select the entity you want to subscribe to from CloudSuite. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you will request from CloudSuite. 5. Select the CloudSuite HTTP Client to use. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **2.2 General Concept** We follow CloudSuite documentation on building this connector, so you can easily use the connector based on [CloudSuite API Reference](https://cloudsuite.atlassian.net/wiki/spaces/CCS/pages/291471404/CloudSuite+API+v1.0+REST). **Entity** The entity you want to subscribe to CloudSuite. Please refer to the entities from [CloudSuite API Reference](https://cloudsuite.atlassian.net/wiki/spaces/CCS/pages/291471404/CloudSuite+API+v1.0+REST) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [CloudSuite API Reference](https://cloudsuite.atlassian.net/wiki/spaces/CCS/pages/291471404/CloudSuite+API+v1.0+REST). Please look at the example below on how to fill the path field when subscribing "Address" entity. Cloudsuite connector screenshot 1 Cloudsuite connector screenshot 2 Based on the documentation, we can see that the endpoint requires "id" as a path. That is why we set the "id" inside the path key in the Request Parameters. * Path is the path parameter of the URL. For example, the \{id}. * A query is a defined set of parameters attached to the end of a URL.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then make a request to CloudSuite with the URL /address/403035324637 **HTTP Client** The HTTP Client configuration you will use to access CloudSuite. ### 3. Publishing Entity to CloudSuite **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select CloudSuite Publisher as the publisher. 2. Select the Action that you want the publisher to perform with the data. 3. Select the CloudSuite entity you want the data to be published to. 4. You can optionally add any path data to the request on the key path. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. 7. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method) on submitting data to CloudSuite. **Entity** We support publishing to most CloudSuite endpoints. Please refer to [CloudSuite API Reference](https://cloudsuite.atlassian.net/wiki/spaces/CCS/pages/291471404/CloudSuite+API+v1.0+REST) page. For example, we want to use "Delete an Asset". Please select “Delete” as the Action and "Asset" as the entity of the publisher. Cloudsuite connector screenshot 3 Cloudsuite connector screenshot 4 Based on the documentation, we can see that the endpoint requires "key" as a path. That is why we set the "key" inside the path key in the data. Cloudsuite connector screenshot 5 * Path is the path parameter of the URL. For example, the \{id}. * A query is a defined set of parameters attached to the end of a URL.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. Alumio will send an API request to CloudSuite with URL /asset/123 **HTTP Client** The HTTP Client configuration you will use to access CloudSuite. # Cohere Source: https://docs.alumio.com/connectors/cohere Connect Alumio to Cohere. ## Extra information System documentation: [Cohere API Reference](https://docs.cohere.com/v2/reference/about) ### Setting up HTTP Client Cohere **Steps** 1. In Alumio Dashboard, go to Connections → HTTPS (API). Create a new HTTP Client and select Cohere HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI and Token. ### Subscribing to Entities from Cohere **Steps** 1. Go to Integrations → Incoming and create a new Incoming configuration and select Cohere Subscriber as the subscriber. 2. Select the entity you want to subscribe to from Cohere. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Cohere HTTP Client to use. **General Concept** We follow the Cohere documentation on building this connector so you can easily use the connector based on the Cohere API Reference. **Entity** It’s the entity you want to subscribe to from Cohere. Please refer to the entities in the Management APIs from the Cohere API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the Cohere API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Single Request entity. Cohere connector screenshot 1 * Path is the path parameter of the URL. For example, the \{id}. * Query is a defined set of parameters attached to the end of a URL.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Cohere connector screenshot 2 That’s why we need to define **id** property inside **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the dataset entity. `/v1/datasets/123456` **Input Transformer** Any transformer set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Cohere. ### Publishing Entity to Cohere **Steps** 1. Go to Integrations → Outgoing, create a new Outgoing configuration, and select CoherePublisher as the publisher. 2. Select the method that you want the publisher to use with the data. 3. Select the Cohere entity you want the data to be published to. 4. Select the HTTP Client to use. Cohere connector screenshot 3 **General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in the Outgoing configuration). **Method** Currently, we support Post (HTTP POST method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Cohere endpoints but not with publishing binary files at the moment. Please refer to the entities in the Management APIs from the Cohere API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Chat with Streaming Outputs. Please select “Post” as the action and “Chat / Chat with Streaming Outputs (API V2)” as the entity of the publisher. Cohere connector screenshot 4 Cohere connector screenshot 5 You can put the payload you want to send to Cohere into the payload property in the data (go to Advanced). * Path is the path parameter of the URL. For example, the \{id}. * Query is a defined set of parameters attached to the end of a URL.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. Alumio will send an API request to Cohere with URL `/v2/chat` **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Cohere. # Connector reference Source: https://docs.alumio.com/connectors/commercetools/reference Connect Alumio to commercetools: HTTP client, subscriber, and publisher. ## Extra information System documentation: [https://docs.commercetools.com/api/](https://docs.commercetools.com/api/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Commercetools * **1.1** Steps * **2.** Subscribing to entities from Commercetools * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Commercetools * **3.1** Steps * **3.2** General concept ### Setting up HTTP Client Commercetools **Steps** 1. In the Alumio Dashboard, go to Connections -> HTTP (API). Create a new HTTP Client and select Commercetools HTTP Client as the prototype of the HTTP Client. 2. Fill in the Region Auth URL, Region API URL, Project Key, Username/Client ID, Password/Client Secret, and Scopes. For more information, see [Commercetools General Concepts](https://docs.commercetools.com/api/general-concepts) 3. You can optionally enable logging of request to get the log of the authentication. 4. Click “Grant Access to Commercetools” and the key will be filled. 5. Save the HTTP Client for use. commercetools connector screenshot 1 ### Subscribing to Entities from Commercetools **Steps** 1. Go to Integrations -> Incoming and create a new incoming configuration and select Commercetools Subscriber as the subscriber (use the latest version **2025-02**). 2. Select the Commercetools HTTP Client to use. 3. Select the Entity you want to subscribe to from Commercetools. 4. Add any request parameters needed to subscribe to the entity. 5. You can optionally add a transformer to modify the request parameters into something you will request from Commercetools. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **General Concept** We follow Commercetools documentation on building this connector, so you can easily use the connector based on [Commercetools API Reference](https://docs.commercetools.com/api/). **HTTP Client** The HTTP Client configuration you will use to access Commercetools. **Method** Currently we support Get (HTTP Get method),and Head(HTTP HEAD method) for publishing data to Commercetools. **Entity** The entity you want to subscribe to from Commercetools. Please refer to the entity from the [Commercetools API Reference](https://docs.commercetools.com/api/) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Commercetools API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity For example, we try subscribing to "Get Order by ID". commercetools connector screenshot 2 We can see in the documentation that there is a projectKey and ID present in the path URL. Alumio will fill in the project key from the HTTP Client, and you can fill in the ID as follows: commercetools connector screenshot 3 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then send this to the Commercetools as /orders/cb4c3632-f8e5-4283-af8b-39e1d45e44b1 **Input Transformer** Any transformers set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. ### Publishing Entity to Commercetools **Steps** 1. Go to Integrations -> Outgoing, create a new outgoing configuration and select Commercetools Publisher as the publisher. 2. Select the HTTP Client to use (use the latest version **2025-02**). 3. Select the Method that you want the publisher to perform with the data. 4. Select the Commercetools entity you want the data to be published to. 5. (Optional) Add any path data to the request on the key path. 6. (Optional) Add any query data to the request on the key query. 7. (Optional) Add any payload data to the request on the key payload. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify the data using transformers. **HTTP Client** The HTTP Client configuration you will use to access Commercetools. **Method** Currently we support Create (HTTP POST method), and Delete (HTTP DELETE method) for publishing data to Commercetools. **Entity** We support publishing to most Commercetools endpoints. Please refer to [Commercetools API Reference](https://docs.commercetools.com/api/) page. Based on the documentation, some endpoints may need one or more path parameters. And below are example data for when we want to use "Update Category by ID" : commercetools connector screenshot 4 We can see in the documentation there is a project key and ID in the path URL. Alumio will fill in the project key from the HTTP Client. So, we still need to fill in the ID example of the data which looks like this: commercetools connector screenshot 5 Alumio will then send this to the Commercetools as /categories/cd4c3632-e8e5-4283-af8b-39e1d45e44b1 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * "Payload" is the data contained within a request. # Connector reference (copy) Source: https://docs.alumio.com/connectors/commercetools/reference-2 Connect Alumio to commercetools: HTTP client, subscriber, and publisher. ## Extra information System documentation: [https://docs.commercetools.com/api/](https://docs.commercetools.com/api/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Commercetools * **1.1** Steps * **2.** Subscribing to entities from Commercetools * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Commercetools * **3.1** Steps * **3.2** General concept ### Setting up HTTP Client Commercetools **Steps** 1. In the Alumio Dashboard, go to Connections -> HTTP (API). Create a new HTTP Client and select Commercetools HTTP Client as the prototype of the HTTP Client. 2. Fill in the Region Auth URL, Region API URL, Project Key, Username/Client ID, Password/Client Secret, and Scopes. For more information, see [Commercetools General Concepts](https://docs.commercetools.com/api/general-concepts) 3. You can optionally enable logging of request to get the log of the authentication. 4. Click “Grant Access to Commercetools” and the key will be filled. 5. Save the HTTP Client for use. commercetools connector screenshot 1 ### Subscribing to Entities from Commercetools **Steps** 1. Go to Integrations -> Incoming and create a new incoming configuration and select Commercetools Subscriber as the subscriber (use the latest version **2025-02**). 2. Select the Commercetools HTTP Client to use. 3. Select the Entity you want to subscribe to from Commercetools. 4. Add any request parameters needed to subscribe to the entity. 5. You can optionally add a transformer to modify the request parameters into something you will request from Commercetools. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **General Concept** We follow Commercetools documentation on building this connector, so you can easily use the connector based on [Commercetools API Reference](https://docs.commercetools.com/api/). **HTTP Client** The HTTP Client configuration you will use to access Commercetools. **Method** Currently we support Get (HTTP Get method),and Head(HTTP HEAD method) for publishing data to Commercetools. **Entity** The entity you want to subscribe to from Commercetools. Please refer to the entity from the [Commercetools API Reference](https://docs.commercetools.com/api/) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Commercetools API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity For example, we try subscribing to "Get Order by ID". commercetools connector screenshot 2 We can see in the documentation that there is a projectKey and ID present in the path URL. Alumio will fill in the project key from the HTTP Client, and you can fill in the ID as follows: commercetools connector screenshot 3 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is a defined set of parameters attached to the end of a url.
Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then send this to the Commercetools as /orders/cb4c3632-f8e5-4283-af8b-39e1d45e44b1 **Input Transformer** Any transformers set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. ### Publishing Entity to Commercetools **Steps** 1. Go to Integrations -> Outgoing, create a new outgoing configuration and select Commercetools Publisher as the publisher. 2. Select the HTTP Client to use (use the latest version **2025-02**). 3. Select the Method that you want the publisher to perform with the data. 4. Select the Commercetools entity you want the data to be published to. 5. (Optional) Add any path data to the request on the key path. 6. (Optional) Add any query data to the request on the key query. 7. (Optional) Add any payload data to the request on the key payload. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify the data using transformers. **HTTP Client** The HTTP Client configuration you will use to access Commercetools. **Method** Currently we support Create (HTTP POST method), and Delete (HTTP DELETE method) for publishing data to Commercetools. **Entity** We support publishing to most Commercetools endpoints. Please refer to [Commercetools API Reference](https://docs.commercetools.com/api/) page. Based on the documentation, some endpoints may need one or more path parameters. And below are example data for when we want to use "Update Category by ID" : commercetools connector screenshot 4 We can see in the documentation there is a project key and ID in the path URL. Alumio will fill in the project key from the HTTP Client. So, we still need to fill in the ID example of the data which looks like this: commercetools connector screenshot 5 Alumio will then send this to the Commercetools as /categories/cd4c3632-e8e5-4283-af8b-39e1d45e44b1 * "Path" is the path parameter of the url. For example the \{id}. * "Query" is defined set of parameters attached to the end of a url.
Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * "Payload" is the data contained within a request. # Transferring products from XML/sFTP Source: https://docs.alumio.com/connectors/commercetools/xml-sftp-guide Guide: transfer products from an XML file on sFTP to commercetools with Alumio. **TABLE OF CONTENTS** * Introduction * The Route * Incoming Configuration * Outgoing Configuration * Entity Transformer * Making The Connection: A Step-by-step Guide * Data X * Filtering Out Unnecessary Tasks When Products Don’t Change * Data Y * Closing Thoughts! ## **Introduction** CommerceTools is considered as one of the frontrunners in the eCommerce space when it comes to customizing business and customer experience. If you are looking to integrate your business with th6e CommerceTools platform, let Alumio sail the ship for you! This guide will provide insights on how to integrate a sFTP environment (containing a product XML file) and a commercial environment with the help of Alumio. This is done by reading an XML file from sFTP and checking whether or not a product has changed. If the product has changed, a task will be created and if it has not, it will be filtered out. ## The Route To begin with, we will start off with a route- Products from XML to CommerceTools. It contains an Incoming configuration- Get Products From XML and an Outgoing configuration- CommerceTools- Create Product. ### Incoming Configuration The Incoming configuration is responsible for retrieving the products from the sFTP environment. Upon clicking View configuration just beneath the Incoming configuration, you can check the nitty gritties of it. For instance, there will be a Subscriber that includes a Filesystem: file subscriber system that connects to the generic Alumio sFTP environment and is looking for a file (in Patterns) called products.xml. ### Outgoing Configuration Similarly, there is an outgoing configuration for the route. If you click on the View configuration just beneath the Outgoing configuration, you will be redirected to the configurations set up page. Here, you will see that it has a Publisher that utilizes the commerce sale publisher Commercetools, which connects to a specific Commercetools HTTP Client (environment) called. The environment is further connected to the Module called Products. #### Entity Transformer Moving on, you will also come across an Entity Transformer within the Outgoing Configuration called Map Product. You click on the View configuration just beneath it to check its functioning. What it does is that it maps the incoming product data to a CommerceTools product. ## Making The Connection: A Step-by-step Guide To have a better understanding, you can check the CommerceTools (open it in another tab). If you click on Products (left-hand panel), you will see that there are no products present right now. If you open the sFTP environment of Alumio, you won’t find anything there as well. What you can do is that you can create a new XML file in the editor. Step 1.1: Create an XML file having three products (for example). Let’s call it data X. #### Data X ``` alumio-t-shirt Alumio T-shirt false alumio-hat Alumio Hat false alumio-hoodie Alumio Hoodie true ``` So, in the above example of data X, we are considering three products namely Alumio T-shirt, Alumio Hat, and Alumio Hoodie respectively. So, each of these products has a name and a status that indicates whether it should or should not be published. Step 1.2: Now, upload this file to the sFTP environment and then go back to Alumio. Step 1.3: Go to the Incoming Configurations of the Route: Get Products From XML, and click on Run Incoming button at the top-right corner. As you run the Incoming configuration, it will connect to the sFTP environment and look for a file called products.xml. Step 1.4: A “Subscriber has been consumed” pop-up box will appear. Hit on Click to view more information just beneath it. Step 1.5: Click on Logs. You can see that Alumio has created tasks (3). To verify this, you can go to the Dashboard (left-hand panel of Alumio). It will show that 3 New tasks have been created. Step 1.6: Go to Dashboard>Tasks and here you will see that all the three tasks belong to the single route called Products from XML to CommerceTools. The entity identifiers will show alumio-hoodie, alumio-hat, and alumio-t-shirt. Step 1.7: Open any one of the tasks. For example, let’s say you open the task with the Identifier: alumio-hat. Step 1.8: Click on Entity Data at the top to view the corresponding data for the task. In this case, what you will see is: ``` { "sku": "alumio-hat", "name": "Alumio Hat", "publish": "false" } ``` This is the data retrieved from XML. As soon as you execute the Route or export the data from Alumio to CommerceTools, the data will get mapped to a format that is compatible with CommerceTools. Eventually, the products will get created on the CommerceTools. Step 2.1: Go back to Routes (Products from XML to CommerceTools) and click on Run Route (top-right corner). A “Publish has been exported” pop-up box will appear. Step 2.2: Revert back to the task (step 1.7). Click on Overview and refresh it. Step 2.3: Now, you will see that the Status is showing FINISHED (in green). Step 2.4: Revisit the CommerceTools merchant center and refresh it. Now, three products will appear (Alumio Hoodie, Alumio T-Shirt, and Alumio Hat), which were created by the execution of the Route. If you look at the status, you will see that the Status for each of them has also been mapped successfully. Alumio Hoodie has been Published (refer to Data X) while the Alumio T-shirt and Alumio Hat remain Unpublished. ## Filtering Out Unnecessary Tasks When Products Don’t Change In scenarios where Alumio reads the same XML file and the products haven’t changed, you can omit creating tasks because they become unnecessary. To do that, you can create a Filter within the Route. Step 3.1: Click on Add entity transformer and select Filter previously stored entities from the drop-down menu. Step 3.2: Next, you have to specify the Storage which will act as a comparison mechanism. It must contain a snapshot of all the imported products. Thus, the next time Alumio reads an XML file, the transformer will compare the snapshot against the file. If everything remains identical, no tasks will be created. However, if any of the products is different, a task will be created for that specific one. Step 3.3: Click on View configuration beneath the Storage to inspect it. Step 3.4: Click on Entities. You will see that it contains three entities (alumio-hoodie, alumio-t-shirt, and alumio-Hat). You can configure the Identifier as per requirement. For example, the Identifier of each entity can be mapped to the sku of the product. You can open any one of the Identifiers to view the data belonging to the specific product. Step 3.5: Go back to the Route and open the Incoming Configuration once again by clicking on View configuration. Step 3.6: Hit the Run Incoming button at the top-right corner and once again the “Subscriber has been consumed” pop-up box will appear. Hit on Click to view more information below it. Step 3.7: Click on Logs. Now, you can see that the data is being filtered, thanks to the entity transformer you have implemented. There are 3 entities that will be filtered and no tasks will be created because every product is already identical to the storage. Step 3.8: You can go back to the Alumio Dashboard again. There will be no New tasks reflected there as well. Step 3.9: Click On the Tasks (left-hand panel of Alumio) and click on Routes (top-left corner). Search for Products from XML to CommerceTools and select it. Then, click on Apply. Step 3.10: Here, you can see that there remains only the 3 tasks that were created in the beginning (step 1.5) and no new tasks have been added. To ensure that the entity transformer - Filter previously stored entities is functioning smoothly, you can make some changes to data X. Let’s call this data Y. #### Data Y ``` alumio-t-shirt Alumio T-shirt false alumio-hat Alumio Hat 123 false alumio-hoodie Alumio Hoodie true alumio-trousers Alumio Trousers true ``` Here, you can change the name of the second product from Alumio Hat to Alumio Hat 123 for example. Also, you can add a new product called Alumio Trousers. Step 3.11: Add data Y (new XML file) to the sFTP environment again (you might have to override the data). Step 3.12: Repeat Step 3.5 and Step 3.6. Now, you can expect two new tasks to be created here- one for the changed product and one for the new one. Step 3.13: Click on Logs and this time you will see that there are two new tasks which have been created. If you revisit the Dashboard, you will see that 2 New tasks are being reflected there as well. Click on the New Tasks and the two new tasks will be reelected here. If you check the Entity Identifier, you shall see that two tasks have been created for alumio-hat and alumio-trousers (which reflects the change we made in step 3.10). If you click on the task for alumio-hat and check the Entity Data, it will reflect the changes. ``` { “sku” : “alumio-hat” “name” : “Alumio Hat 123” “Publish” : “false” } ``` Similarly, If you click on the task for alumio-trousers and check the Entity Data, you can see that the data has been retrieved for the new product. ``` { “sku” : “alumio-trousers” “name” : “Alumio Trousers” “Publish” : “true” } ``` ## Closing Thoughts! When it comes to providing the best iPaaS solution to help businesses achieve smooth system-to-system integrations, Alumio certainly beats the competition by quite a margin. Being a user-friendly platform, it allows even the non-technical people to use it for a wide range of integrations. Let’s hope that this article has provided you a deep understanding of how to transfer products from XML/sFTP to Alumio. Stay tuned with us to learn more in some other article! # ConnectWise Source: https://docs.alumio.com/connectors/connectwise Connect Alumio to ConnectWise. ## Extra information System documentation: [ConnectWise API Reference](https://developer.connectwise.com/Products/ConnectWise_PSA/REST) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client ConnectWise * **1.1** Steps * **2.** Subscribing to entities from ConnectWise * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to ConnectWise * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client ConnectWise **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select ConnectWise HTTP Client as PlatForm and click next step 3. Fill in the Base URI, Client ID, Company ID, Public Key and Private Key. (See the [ConnectWise Authentication Documentation](https://developer.connectwise.com/Products/ConnectWise_PSA/Developer_Guide/Authentication) for more information) 4. You can optionally enable logging of request to get the log of the authentication. 5. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. ### 2. Subscribing to Entities from ConnectWise **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "ConnectWise Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from ConnectWise. 3. Add any request parameters needed to subscribe to the entity. 4. Select the ConnectWise HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from ConnectWise. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow ConnectWise documentation on building this connector, so you can easily use the connector based on [ConnectWise API Reference](https://developer.connectwise.com/Products/ConnectWise_PSA/REST). **Entity** The entity you want to subscribe to ConnectWise. Please refer to the entities from [ConnectWise API Reference](https://developer.connectwise.com/Products/ConnectWise_PSA/REST) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [ConnectWise API Reference](https://developer.connectwise.com/Products/ConnectWise_PSA/REST). Please look at the example below on how to fill request parameters when we want retrieve an address format ["AddressFormats - Get AddressFormat by id"](https://developer.connectwise.com/Products/ConnectWise_PSA/REST#/AddressFormats/getCompanyAddressFormatsById) entity. ConnectWise connector screenshot 1 ConnectWise connector screenshot 2 From the end point, we can see that we need to set the "id" as a path. That is why we set the "id" as a path the Request Parameters. Alumio will then make a request to ConnectWise with the URL `/company/addressFormats/4` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access ConnectWise. **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "ConnectWise Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the ConnectWise entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, HTTP Put, HTTP Patch method and HTTP Delete method on submitting data to ConnectWise. **Entity** We support publishing to all ConnectWise endpoints. Please refer to [ConnectWise API Reference](https://developer.connectwise.com/Products/ConnectWise_PSA/REST) page. For example, we want to update an address format. Please select “Put” as the Method and ["AddressFormats - Put AddressFormat"](https://developer.connectwise.com/Products/ConnectWise_PSA/REST#/AddressFormats/putCompanyAddressFormatsById). ConnectWise connector screenshot 3 ConnectWise connector screenshot 4 From the documentation, we can see that we need to set a path for "id" and a body parameters. That is why we set the "id" inside the path key and the body parameters inside the payload key in the data. ConnectWise connector screenshot 5 Alumio will send an API request to ConnectWise with URL `/company/addressFormats/4` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access ConnectWise. # Constant Contact Lead Gen & CRM Source: https://docs.alumio.com/connectors/constant-contact-lead-gen-crm Connect Alumio to Constant Contact Lead Gen & CRM. Lead Gen & CRM is an Easy to use Lead Gen & CRM software to attract and win more business. Capture every opportunity, prioritize your leads, and convert them faster. ## Extra information System documentation: [Lead Gen & CRM API Reference](https://knowledgebase.constantcontact.com/lead-gen-crm/articles/KnowledgeBase/50374-Understanding-Lead-Gen-CRM-Open-API-Overview?lang=en_US#h_474050452121518635016023) **Lead Gen & CRM** **Connector Package Documentation** # Setting up HTTP Client Lead Gen & CRM ## Steps 1. In the Alumio Dashboard, go to Clients > HTTP Client. Create a new HTTP Client and select Lead Gen & CRM HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI (Example: [http://api.yourappdomain.com/pubapi](http://api.yourappdomain.com/pubapi)). 3. Choose the version and Fill the AccountID & SrcretKey 4. Enable the logging (Optional but recommended) 5. Save and Continue. Constant Contact Lead Gen & CRM connector screenshot 1 # Subscribing to Entities from Lead Gen & CRM ## Steps 1. Go to Connections -> Incoming, create a new incoming configuration, and select Lead Gen & CRM - Subscriber as the subscriber. 2. Select the entity to subscribe to Lead Gen & CRM. 3. Add any request parameters and the Payload needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Lead Gen & CRM Client to use. ## General Concept We follow Lead Gen & CRM documentation on building this connector, so you can easily use the connector based on Lead Gen & CRM API Reference. **Entity** It's the entity from Lead Gen & CRM you want to subscribe to. Please refer to the entities in Management APIs from the Lead Gen & CRM API Reference page. **Request Parameters** You can provide these parameters to get the needed entity based on Lead Gen & CRM API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing to Leads entities. Constant Contact Lead Gen & CRM connector screenshot 2 Constant Contact Lead Gen & CRM connector screenshot 3 The Payload is mandatory, especially the payload.id & payload.params. payload.id is A user-supplied request ID for correlating requests. That’s why we must define the **id** property inside the "Payload" property in the Request Parameters field. The properties inside the payload will be sent as the POST payload data. **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** It's the HTTP Client configuration or prototype you will use to access Lead Gen & CRM Rest API. # Publishing Entity to Lead Gen & CRM ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Lead Gen & CRM Publisher as the publisher. 2. Select the action you want the publisher to do with the data. 3. Select the Lead Gen & CRM entity where the data will be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add transformers to transform the data into anything you need before submitting it to Lead Gen & CRM. 6. Select the HTTP Client to use. Constant Contact Lead Gen & CRM connector screenshot 4 ## General Concept Like the subscriber, the publisher has similar methods for using it. The difference is the payload that will be submitted by the publisher originating from the data (from routes and transformers in outgoing configuration). **Entity** We support publishing to most Lead Gen & CRM REST endpoints. Please look at the example below for endpoints that require an object as the request payload. For example, we want to update the Lead data. Constant Contact Lead Gen & CRM connector screenshot 5 You can put the payload you want to send to Lead Gen & CRM into the payload property in the data. Here is an example of the Possible Response after the Update process. Constant Contact Lead Gen & CRM connector screenshot 6 **HTTP Client** It's the HTTP Client configuration or prototype you will use to access Lead Gen & CRM REST API. # Copernica Source: https://docs.alumio.com/connectors/copernica Connect Alumio to Copernica. ## Extra information System documentation: [Copernica API Reference](https://www.copernica.com/en/documentation/restv4/rest-api) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client * **1.1** Steps * **2.** Subscribing to entities from Copernica * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Copernica * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Copernica HTTP Client as Platform and click Next Step 3. Fill in the Base URL, Authentication JWT URL, and the Access token. 4. You can optionally enable logging of requests to get the log of the HTTP requests. 5. Click next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use. Copernica connector screenshot 1 ### 2. Subscribing to Entities from Copernica **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Copernica Subscriber" as the subscriber. 2. Select the Copernica HTTP Client to use. 3. Select the entity you want to subscribe to from Copernica. 4. Add any request parameters needed to subscribe to the entity. 5. You can optionally add a transformer to transform the request parameters into something you will request from Copernica. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **2.2 General Concept** We follow the Copernica documentation on building this connector, so you can easily use the connector based on [Copernica API Reference](https://www.copernica.com/en/documentation/restv4/rest-api). **Entity** The entity you want to subscribe to Copernica. Please refer to the entities from [Copernica API Reference](https://www.copernica.com/en/documentation/restv4/rest-api) page. **Request Parameters** You can provide these parameters to get the needed entity based on the [Copernica API Reference](https://www.copernica.com/en/documentation/restv4/rest-api). Please look at the example below on how to fetch all profiles from the specific database by subscribing to the "Database & Collections - fetch all profiles" entity. Copernica connector screenshot 2 Copernica connector screenshot 3 From the endpoint, we can see that we need to set the database id as a parameter. That is why we set the "id" inside the path key in the Request Parameters. Alumio will then make a request to Copernica with the URL `https://api.copernica.com/v4/database/{{id}}/collections` * Path is the path parameter of the URL. For example, the \{id}. * A query is a defined set of parameters attached to the end of a URL.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access Copernica. **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select "Copernica Publisher" as the publisher. 2. Select the HTTP Client to use. 3. Select the Method you want the publisher to use with the data. 4. Select the entity you want the data to be published to. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. **3.2 General Concept** Like the subscriber, the publisher has similar methods for using it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify the payload using the Request Transformer. **Method** Currently, we support the HTTP Post, Put, and Delete method on submitting data to Copernica. **Entity** We support publishing to all Copernica endpoints. Please refer to the Copernica API Reference For example, we want to update a profile. Please select “Put” as the Method and "Profile & Subprofile - Update the profile information". Copernica connector screenshot 4 Copernica connector screenshot 5 From the documentation, we can see that we need to set a path parameter and a body parameter. That is why we set the "id" as a profile ID inside the path key and body parameters inside the payload key in the data. Copernica connector screenshot 6 Alumio will send an API request to Copernica with URL `PUT https://api.copernica.com/v4/profile/$id ` with the defined payload. * Path is the path parameter of the URL. For example the \{ContainerId}. * Query is a defined set of parameters attached to the end of a URL.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Copernica. # Copper Source: https://docs.alumio.com/connectors/copper Connect Alumio to Copper. ## Extra information System documentation: \[Copper API Reference] # Setting up HTTP Client Copper ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Copper HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, Authentication type. * Oauth2.0 : Fill the Client ID, Client Secret, and Scopes. (Authorize | Access Token URL is optional), Grant Access to Copper. * Api Keys : Fill in X-PW-AccessToken, X-PW-Application, and X-PW-UserEmail. * Save the Client for use later. # Subscribing to Entities from Copper ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select Copper Subscriber as the subscriber. * Select the entity you want to subscribe from Copper . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the Copper HTTP Client to use. ## General Concept We follow Copper documentation on building this connector so you can easily use the connector based on Copper API Reference. **Method** It’s the Method you want to subscribe from Copper. Based on the Method, the Entity will change. **Entity** It’s the entity you want to subscribe from Copper . Please refer to the entities in Management APIs from Copper API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Copper API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing See a Persons Activities. Copper connector screenshot 1 Copper connector screenshot 2 That’s why we need to define the **example\_person\_id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on See a Persons Activities. /developer\_api/v1/people/123321/activities **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Copper . # Publishing Entity to Copper ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select Copper Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the Copper entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to Copper . * Select the HTTP Client to use. Copper connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Copper endpoints. Please refer to the entities in Management APIs from the Copper API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a New Company. Please select “Post” as the action and “Create a New Company” as the entity of the publisher. Copper connector screenshot 4 Copper connector screenshot 5 You can put the payload you want to send to Copper into the payload property in the data. Alumio will send an API request to Copper with URL /developer\_api/v1/companies **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Copper . # CS-Cart Source: https://docs.alumio.com/connectors/cs-cart Connect Alumio to CS-Cart. ## Extra information System documentation: [CS-Cart API Reference](https://docs.cs-cart.com/latest/developer_guide/api/index.html) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client CS-Cart * **1.1** Steps * **2.** Subscribing to entities from CS-Cart * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to CS-Cart * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client CS-Cart **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select "CS-Cart HTTP Client" as the HTTP Client. 2. Fill in the Base URI, Email, and API Key. (For more information, see [CS-Cart Authentication Reference](https://docs.cs-cart.com/latest/developer_guide/api/index.html#authentication)) 3. You can optionally enable logging of request to get the log of the authentication. 4. Save the HTTP Client for use. ### 2. Subscribing to Entities from CS-Cart **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "CS-Cart Subscriber" as the subscriber. 2. Select the Object to subscribe to from CS-Cart. 3. Fill in the Object Id (optional). 4. Select Nested Object (optional). 5. Fill in the Nested Object Id (optional). 6. Add any Query parameters needed to subscribe. 7. You can optionally add a transformer to transform the request parameters into something you will request from CS-Cart. 8. You can also optionally enable pagination to allow Alumio fetches paginated entities. 9. Select the CS-Cart HTTP Client to use. **2.2 General Concept** We follow CS-Cart documentation on building this connector, so you can easily use the connector based on [CS-Cart API Reference](https://docs.cs-cart.com/latest/developer_guide/api/index.html). **Object** The object you want to subscribe to CS-Cart. Please refer to the object from [CS-Cart API Reference](https://docs.cs-cart.com/latest/developer_guide/api/index.html) page. **Query Parameters** These are the query parameters you can provide based on the [CS-Cart API Reference](https://docs.cs-cart.com/latest/developer_guide/api/index.html) page.. Please look at the example below on how to fill object when we try to get a particular ["product variation"](https://docs.cs-cart.com/latest/developer_guide/api/entities/product_variations.html) of a particular ["product variation group"](https://docs.cs-cart.com/latest/developer_guide/api/entities/product_variation_groups.html). CS-Cart connector screenshot 1 CS-Cart connector screenshot 2 Based on the Documentation, we pick the ["Product Variation Groups"](https://docs.cs-cart.com/latest/developer_guide/api/entities/product_variation_groups.html) as the Object, then fill 1 in the "Object Id". We continue by pick ["Product Variations"](https://docs.cs-cart.com/latest/developer_guide/api/entities/product_variations.html) as the Nested Object and filling 1 in the "Nested Object Id". Alumio will then make a request to CS-Cart with the URL /product\_variations\_groups/1/product\_variations/1 and get this specific product variation. * Query Parameters is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) **HTTP Client** The HTTP Client configuration you will use to access CS-Cart. ### 3. Publishing Entity to CS-Cart **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "CS-Cart Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the CS-Cart Object you want the data to be published to. 4. Fill in the Object Id (optional). 5. Select Nested Object (optional). 6. Fill in the Nested Object Id (optional). 7. You can optionally add any query data to the request on the key query. 8. You can optionally add any payload data to the request on the key payload. 9. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Object** We support publishing to most CS-Cart endpoints. Please refer to [CS-Cart API Reference](https://docs.cs-cart.com/latest/developer_guide/api/index.html) page. For example, we want to create a product. Please select Post as the method and ["Products"](https://docs.cs-cart.com/latest/developer_guide/api/entities/products.html) as the object of the publisher. We don't have to fill in the "Object Id" and "Nested Object Id", we also don't need to select anything from the "Nested Object." CS-Cart connector screenshot 3 CS-Cart connector screenshot 4 Based on the documentation, we need to add a Body Request. So we put the body inside the payload key in the Data. CS-Cart connector screenshot 5 Alumio will send an API request to CS-Cart with URL /products CS-Cart will then return the newly created "product\_id" CS-Cart connector screenshot 6 * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access CS-Cart. # Datadog Source: https://docs.alumio.com/connectors/datadog Connect Alumio to Datadog. ## Extra information System documentation: [Datadog API Reference](https://docs.datadoghq.com/api/latest/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Datadog * **1.1** Steps * **2.** Subscribing to entities from Datadog * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Datadog * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Datadog **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Datadog HTTP Client as PlatForm and click next step 3. Fill in the Base URI and API key. 4. You can optionally enable Application Key that is required for some Datadog End Points. 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. Datadog connector screenshot 1 ### 2. Subscribing to Entities from Datadog **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Datadog Subscriber" as the subscriber. 2. Select the method you want to subscribe to from Datadog. 3. Select the entity you want to subscribe to from Datadog. 4. Add any request parameters needed to subscribe to the entity. 5. Select the Datadog HTTP Client to use. 6. You can optionally add a transformer to transform the request parameters into something you will request from Datadog. 7. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Datadog documentation on building this connector, so you can easily use the connector based on [Datadog API Reference](https://docs.datadoghq.com/api/latest/). **Entity** The entity you want to subscribe to Datadog. Please refer to the entities from [Datadog API Reference](https://docs.datadoghq.com/api/latest/) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Datadog API Reference](https://docs.datadoghq.com/api/latest/). Please look at the example below on how to fill path field when we want retrieve details of an incident by subscribing ["Incidents - Get the details of an incident"](https://docs.datadoghq.com/api/latest/incidents/#get-the-details-of-an-incident) entity. Datadog connector screenshot 2 Datadog connector screenshot 3 From the end point, we can see that we need to set the incident id as parameters. That is why we set the "incident\_id" inside the path key in the Request Parameters. Alumio will then make a request to Datadog with the URL `https://api.datadoghq.com/api/v2/incidents/123` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` **HTTP Client** The HTTP Client configuration you will use to access Datadog. ### 3. Publishing Entity to Datadog **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Datadog Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the Datadog entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method and HTTP Delete method on submitting data to Datadog. **Entity** We support publishing to most Datadog endpoints. Please refer to [Datadog API Reference](https://docs.datadoghq.com/api/latest/) page. For example, we want to delete an eorder. Please select “Delete” as the Method and ["Roles - Delete role"](https://docs.datadoghq.com/api/latest/roles/#delete-role). Datadog connector screenshot 4 Datadog connector screenshot 5 From the end point, we can see that we need to set role id as parameters. That is why we set the "role\_id" inside the path key in the data. Datadog connector screenshot 6 Alumio will send an API request to Datadog with URL `https://api.datadoghq.com/api/v2/roles/123` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Datadog. # Dolibarr Source: https://docs.alumio.com/connectors/dolibarr Connect Alumio to Dolibarr ERP & CRM. Dolibarr is a Open Source ERP & CRM for Business. ## Extra information System documentation: [Dolibarr API Reference](https://wiki.dolibarr.org/index.php?title=Module_Web_Services_API_REST_\(developer\)) **Dolibarr** **Connector Package Documentation** # Setting up HTTP Client Dolibarr ## Steps 1. In the Alumio Dashboard, go to Clients > HTTP Client. Create a new HTTP Client and select Dolibarr HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI (Example: [https://your-dolibarr.saas2.doliondemand.fr/api/index.php](https://your-dolibarr.saas2.doliondemand.fr/api/index.php)). 3. Fill the Username & Password 4. Enable the logging (Optional but recommended) 5. Enable the caching of the token and select or create the storage for the token (recommended) 6. Save and Continue. Dolibarr connector screenshot 1 # Subscribing to Entities from Dolibarr ## Steps 1. Go to Connections -> Incoming, then create a new incoming configuration and select Dolibarr - Subscriber as the subscriber. 2. Select the entity you want to subscribe to Dolibarr. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Dolibarr Client to use. ## General Concept We follow Dolibarr documentation on building this connector, so you can easily use the connector based on Dolibarr API Reference. **Entity** It’s the entity you want to subscribe from Dolibarr. Please refer to the entities in Management APIs from the Dolibarr API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Dolibarr API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing One Contracts entity Dolibarr connector screenshot 2 Dolibarr connector screenshot 3 That’s why we need to define the **id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such a Request Parameters field on the Contract entity. /api/index.php/contracts/\{CONTRACT\_ID\_HERE} **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Dolibarr Rest API. # Publishing Entity to Dolibarr ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Dolibarr Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Dolibarr entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Dolibarr. 6. Select the HTTP Client to use. Dolibarr connector screenshot 4 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Entity** We support publishing to most Dolibarr REST endpoints. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Contact Dolibarr connector screenshot 5 You can put the payload you want to send to Dolibarr into the payload property in the data. Here is an example of the Possible Response after Creation. Dolibarr connector screenshot 6 Which only returns the ID of the new contact. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Dolibarr REST API. # DynamicWeb Source: https://docs.alumio.com/connectors/dynamicweb Connect Alumio to DynamicWeb. ## Extra information System documentation: [https://doc.dynamicweb.com/dwapi/docs/index.html?url=/dwapi/api.json\&layout=BaseLayout#](https://doc.dynamicweb.com/dwapi/docs/index.html?url=/dwapi/api.json\&layout=BaseLayout#) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client DynamicWeb * **1.1** Steps * **2.** Subscribing to entities from DynamicWeb * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to DynamicWeb * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client DynamicWeb **1.1 Steps** 1. In Alumio Dashboard, go to Storages > Storages. Create a new Storage and select default Prototype as the prototype of the Storage. 2. Check the Enable pruning of storage items and Set the Time to live at 30 minutes DynamicWeb connector screenshot 1 3. Save the Storage. 4. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select DynamicWeb HTTP Client as the prototype of the HTTP Client. 5. Fill in the Base URI, Username, Password, Shop Id and expiration in Seconds. You need to change the storage time to live when changing expiration in seconds accordingly. 6. Set the storage as the one that you save at previous step. 7. You can optionally enable logging of request to get the log of the authentication. 8. Save the HTTP Client. DynamicWeb connector screenshot 2 ### 2. Subscribing to Entities from DynamicWeb **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select DynamicWeb Subscriber as the subscriber. 2. Select the entity you want to subscribe from DynamicWeb. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the DynamicWeb HTTP Client to use. **2.2 General Concept** We follow DynamicWeb documentation on building this connector so you can easily use the connector based on DynamicWeb API Reference. **Entity** It’s the entity you want to subscribe from DynamicWeb. Please refer to the entities in Management APIs from DynamicWeb API Reference. **Request Parameters** These are the parameters you can provide to get the needed entity based on DynamicWeb API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Products\_GetProduct. DynamicWeb connector screenshot 3 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) DynamicWeb connector screenshot 4 Because the id is inside path, we put it like that. This will be sent to DynamicWeb system as /dwapi/ecommerce/products/123 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration you will use to access DynamicWeb. ### 3. Publishing Entity to DynamicWeb **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select DynamicWeb Publisher. 2. Select the method that you want the publisher to do with the data currently DynamicWeb support Post, Put, Patch and Delete. 3. Select the DynamicWeb entity you want the data to be published to. 4. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Method** Currently we support Post, Put, Patch and Delete. **Entity** We support publishing to most DynamicWeb endpoints. Please refer to the entities from DynamicWeb API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a new user. Please select “Post” as the method and “Users\_Create” as the entity of the publisher. DynamicWeb connector screenshot 5 DynamicWeb connector screenshot 6 You can put the payload you want to send to DynamicWeb into payload property in the data. Here is an example of the Payload for creating the user. DynamicWeb connector screenshot 7 DynamicWeb connector screenshot 8 DynamicWeb connector screenshot 9 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. Alumio will send an API request to DynamicWeb with URL /dwapi/users/create **HTTP Client** It’s the HTTP Client configuration you will use to access DynamicWeb. # Ebay Source: https://docs.alumio.com/connectors/ebay Connect Alumio to Ebay. ## Extra information Connector package documentation: System documentation: # Setting up HTTP Client eBay ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select eBay HTTP Client as the prototype of the HTTP Client. 2. Choose the Environment (either sandbox, or production), Authentication type (Interactive or Client), Client ID, Client Secret, and scopes. 3. Press “Grant Access to eBay Center” Note : If you need to input redirect URI, Alumio Redirect URL is on Settings > Info **When utilizing the OAuth2 authorization code method, eBay manages this in two stages:** 1. Interactive authorization involves consenting to eBay by logging in with a user. Upon successful completion, you receive a code that must be used in the next step, Heres example of the consent request. Ebay connector screenshot 1 This HTML request redirects a user to your application's **Grant Application Access** page. If they consent to the conditions outlined on the page, the redirect returns the user to your application, and the redirect back to your application contains an **authorization code** . 2. Authorization code entails requesting an access token based on the acquired authentication code. Heres and Example in Alumio Ebay connector screenshot 2 **Heres cURL example on Oauth2 client credentials** Ebay connector screenshot 3 In Alumio Ebay connector screenshot 4 This page in eBay documentation describes the request parameters needed to build the consent request: [https://developer.ebay.com/api-docs/static/oauth-consent-request.html](https://developer.ebay.com/api-docs/static/oauth-consent-request.html) # Subscribing to Entities from eBay ## Steps 1. Go to Connections -> Incoming, create a new incoming configuration, and select eBay Subscriber as the subscriber. 2. Select the entity you want to subscribe from eBay. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. ## Select the Ebay HTTP Client to use. General Concept We follow Ebay documentation on building this connector so you can easily use the connector based on Ebay API Reference. **Entity** It’s the entity you want to subscribe from Ebay. Please refer to the entities in Management APIs from Ebay API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Ebay API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity. Ebay connector screenshot 5 Ebay connector screenshot 6 That’s why we need to define **custom\_policy\_id** property inside **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field. /custom\_policy/1 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Ebay. # Publishing Entity to Ebay ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration and select Ebay Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Ebay entity you want the data to be published to. 4. Select the HTTP Client to use. Ebay connector screenshot 7 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently we support Create (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Ebay endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Ebay API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to Create a Custom Policy. Please select “Create” as the action and “createCustomPolicy” as the entity of the publisher. Ebay connector screenshot 8 Ebay connector screenshot 9 You can put the payload you want to send to Ebay into payload property in the data. Here is an example of the Possible Response after Creation. Ebay connector screenshot 10 Alumio will send an API request to Ebay with URL /custom\_policy **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Ebay. # Ecwid Source: https://docs.alumio.com/connectors/ecwid Connect Alumio to Ecwid. ## Extra information System documentation: [Ecwid API Reference](https://api-docs.ecwid.com/reference/access-ecwid-api) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Ecwid * **1.1** Steps * **2.** Subscribing to entities from Ecwid * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Ecwid * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Ecwid **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Ecwid HTTP Client as PlatForm and click the next step 3. Fill in the Base URI, Store ID, and Client ID and select the Authentication Type of your Ecwid instance (OAuth or using access Token. 4. You can optionally set a base HTTP client to use for the connection by selecting an HTTP client configuration or setting your own HTTP client in the Advanced HTTP client field 5. Click the Grant access to Ecwid button to get the access token (If you're using Oauth as your Authentication Type). 6. You can optionally change how Alumio logs every HTTP request made by the HTTP client 7. Click the next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use. Ecwid connector screenshot 1 ### 2. Subscribing to Entities from Ecwid **2.1 Steps** 1. Go to Connections -> Incoming, create a new incoming configuration, and select Ecwid Subscriber as the subscriber. 2. Select the entity you want to subscribe from Ecwid. 3. Add any request parameters needed to subscribe to the entity (optional). 4. Select the Ecwid HTTP Client to use 5. You can optionally add a transformer to transform the request parameters into something you will request from Ecwid. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **2.2 General Concept** We follow Ecwid API documentation on building this connector, so you can easily use the connector based on [Ecwid API Reference](https://api-docs.ecwid.com/reference/rest-api). **Entity** It’s the entity you want to do (fetching data from Ecwid). Please refer to the [Ecwid API Reference](https://api-docs.ecwid.com/reference/rest-api) page. **Request Parameters** It’s the parameters you can provide to get the needed entity based on [Ecwid API Reference](https://api-docs.ecwid.com/reference/rest-api) Documentation. For example, we want to subscribe to Product details with endpoint /products/596377786 with productId = 596377786. We add this Json at the Request parameter area. Ecwid connector screenshot 2 Ecwid connector screenshot 3 It will transform to /products/596377786 That’s why we need to define the Product ID property inside the payload property in the Request Parameters field. Alumio will then make a request to Ecwid. **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** The HTTP Client configuration you will use to access Ecwid. ### 3. Publishing Entity to Ecwid **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select "Ecwid Publisher" as the publisher. 2. Select the Method you want the publisher to use with the data. 3. Select the Ecwid entity to which the data will be published. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. Ecwid connector screenshot 4 **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). However, you can also add or modify the payload using the Request Transformer. **Method** Currently, we support POST, PUT, and DELETE methods. **Entity** We support publishing to most Ecwid endpoints but not with publishing binary files at the moment. Please refer to the entities from the Ecwid API Reference page. Based on the documentation, some endpoints may need one or more path parameters. **Action** We support publishing to most Ecwid endpoints. Please refer to [Ecwid API Reference](https://api-docs.ecwid.com/reference/rest-api) Documentation page. Please look at the example below. For example, we want to update a product with productId = 596377786 by using the patch method. Please select method PUT and "Products - Update a Product" as the entity action of the publisher. The documentation describes that we need Product property as a request body. In that case, you need to provide the Product property into the payload property in the data, either as an output from Routes or output from Transformers in the Outgoing Configuration. Here is an example of the required data. **HTTP Client** It’s the HTTP Client configuration or prototype that you will use to access Ecwid. # eDesk Source: https://docs.alumio.com/connectors/edesk Connect Alumio to eDesk. ## Extra information System documentation: ## Connector package documentation **Setting up HTTP Client EDesk** **Steps** 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select EDesk HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Username, and Password **Subscribing to Entities from EDesk** **Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select EDesk Subscriber as the subscriber. 2. Select the entity you want to subscribe from EDesk. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the EDesk HTTP Client to use. **General Concept** We follow EDesk documentation on building this connector so you can easily use the connector based on EDesk API Reference. **Entity** It’s the entity you want to subscribe from EDesk. Please refer to the entities in Management APIs from the EDesk API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on EDesk API Reference. Please look at the example below on how to fill the Request Parameters field when Get custom fields entity eDesk connector screenshot 1 eDesk connector screenshot 2 That’s why we need to define the id property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the Get custom fields entity. /v1/threads/448689220/custom-field **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access EDesk. **Publishing Entity to EDesk** **Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select EDesk Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the EDesk entity you want the data to be published. 4. Select the HTTP Client to use. eDesk connector screenshot 3 **General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently, we support Create (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most EDesk endpoints. Please refer to the entities in Management APIs from the EDesk API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Thread. Please select “Create” as the action and “Create a Thread” as the entity of the publisher. eDesk connector screenshot 4 eDesk connector screenshot 5 You can put the payload you want to send to EDesk into the payload property in the data. Here is an example of the Possible Response after Creation. eDesk connector screenshot 6 Alumio will send an API request to EDesk with URL /v1/threads **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access EDesk. # EffectConnect Source: https://docs.alumio.com/connectors/effectconnect Connect Alumio to EffectConnect. ## Extra information System documentation: [EffectConnect API Reference](https://docs.effectconnect.com/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client EffectConnect * **1.1** Steps * **2.** Subscribing to entities from EffectConnect * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to EffectConnect * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client EffectConnect **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select EffectConnect HTTP Client as PlatForm and click next step 3. Fill in the Base URI. (For more information, see [EffectConnect Reference](https://docs.effectconnect.com/)) 4. Click the next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use. EffectConnect connector screenshot 1 ### 2. Subscribing to Entities from EffectConnect **2.1 Steps** 1. Go to Connections -> Incoming, create a new incoming configuration, and select Effectconnect Subscriber as the subscriber. 2. Select the entity you want to subscribe from Effectconnect. 3. Add public key, secret key, and any request parameters needed to subscribe to the entity (optional). 4. Select the Effectconnect HTTP Client to use 5. You can optionally add a transformer to transform the request parameters into something you will request from EffectConnect. 6. You can also optionally enable pagination to allow Alumio to fetch paginated entities. **2.2 General Concept** We follow EffectConnect documentation on building this connector, so you can easily use the connector based on [EffectConnect API Reference](https://docs.effectconnect.com/documentation/build-an-api-call). **Entity** It’s the entity you want to subscribe from Effectconnect. Please refer to the entities in Management APIs from the [EffectConnect API Reference](https://docs.effectconnect.com/documentation) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Effectconnect API Reference. Please look at the example below on how to fill Request Parameters when subscribing Process Status EffectConnect connector screenshot 2 EffectConnect connector screenshot 3 EffectConnect connector screenshot 4 That’s why we need to define the ID property inside the process property in the Request Parameters field. Based on the documentation, it only provides XML examples. We can convert XML to JSON using [https://codebeautify.org/xmltojson](https://codebeautify.org/xmltojson). Alumio will then make a request to EffectConnect with the URL /process * Path is the path parameter of the url. For example, the \{id}. * Query is a defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. **HTTP Client** The HTTP Client configuration you will use to access EffectConnect. ### 3. Publishing Entity to EffectConnect **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select "EffectConnect Publisher" as the publisher. 2. Select the Method you want the publisher to use with the data. 3. Select the EffectConnect entity to which the data will be published. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). However, you can also add or modify payload using the Request Transformer. **Method** Currently, we support POST and PUT methods. **Entity** We support publishing to most Effectconnect endpoints but not with publishing binary files at the moment. Please refer to the entities from the Effectconnect API Reference page. Based on the documentation, some endpoints may need one or more path parameters. **HTTP Client** It’s the HTTP Client configuration or prototype that you will use to access Effectconnect. # ERPNext Source: https://docs.alumio.com/connectors/erpnext Connect Alumio to ERPNext. ## Extra information System documentation: [ERPNext API Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client ERPNext * **1.1** Steps * **2.** Subscribing to entities from ERPNext * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to ERPNext * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client ERPNext **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select "ERPNext HTTP Client" as the HTTP Client. 2. Choose OAuth 2 for Authentication Type. 3. Fill in the the Base URI Access Token URL, Authorize URL Client ID, Client Secret and Scope. (For more information, see [ERPNext Oauth2 Authentication Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api/oauth-2)) 4. Click on "Grant access to ERPNext" and you will be redirected to approve the grant. 5. You can optionally enable logging of request to get the log of the authentication. 6. Save the HTTP Client for use. 7. Alternatively, you can use Token Based Authentication. In that case, please select Token Based as Authentication Type, fill the Base URI and Token, then save the HTTP Client. (For more information, see [ERPNext Token Based Authentication Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api/token_based_authentication)) ERPNext connector screenshot 1 ERPNext connector screenshot 2 ### 2. Subscribing to Entities from ERPNext **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "ERPNext Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from ERPNext. 3. Add any request parameters needed to subscribe to the entity. 4. Select the ERPNext HTTP Client to use. 5. You can optionally add a transformer to transform the data into something you will be used to request from ERPNext. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow ERPNext documentation on building this connector, so you can easily use the connector based on [ERPNext API Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api). **HTTP Client** The HTTP Client configuration you will use to access ERPNext. **Entity** The entity you want to subscribe to ERPNext. Please refer to the entities from [ERPNext API Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [ERPNext API Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api). Please look at the example below on how to fill path field when subscribing ["Retrieve a specific document by name (ID)"](https://frappeframework.com/docs/user/en/guides/integration/rest_api#rest) entity. ERPNext connector screenshot 3 Based on the documentation, we can see that the end point require "doctype" and "name" as a parameter. That is why we set the "doctype" and "name" inside the path key in the Request Parameters. Alumio will then make a request to ERPNext with the URL /api/resource/Lead/CRM-LEAD-2024-00001 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` ### 3. Publishing Entity to ERPNext **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "ERPNext Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the ERPNext entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, Update HTTP Put method and HTTP Delete method on submitting data to ERPNext. **Entity** We support publishing to most ERPNext endpoints. Please refer to [ERPNext API Reference](https://frappeframework.com/docs/user/en/guides/integration/rest_api) page. For example, we want to add a new product. Please select “Post” as the Method and ["Create a new document of this DocType"](https://frappeframework.com/docs/user/en/guides/integration/rest_api#rest) as the entity of the publisher. ERPNext connector screenshot 4 Based on the documentation, it requires a "Request Body". That is why we set the "Request Body" inside the payload key in the data. ERPNext connector screenshot 5 Alumio will send an API request to ERPNext with URL /api/resource/Lead Another example is when we want to delete a product by id. Please select “Delete” as the Action and ["Delete a specific document by name (ID)"](https://frappeframework.com/docs/user/en/guides/integration/rest_api#rest) as the entity of the publisher. ERPNext connector screenshot 6 Based on the documentation, we can see that the end point require "doctype" and "name" as a parameter. That is why we set the "doctype" and "name" inside the path key in the data. ERPNext connector screenshot 7 Alumio will then make a request to ERPNext with the URL /api/resource/Lead/CRM-LEAD-2024-00001 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access ERPNext. # Exact Globe Source: https://docs.alumio.com/connectors/exact-globe Connect Alumio to Exact Globe. ## Extra information System documentation: [Exact Globe - Alumio API Plugin API Reference](https://demo-api.clickker.nl/swagger/ui/index#/) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Exact Globe - Alumio API Plugin * **1.1** Steps * **2.** Subscribing to entities from Exact Globe - Alumio API Plugin * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Exact Globe - Alumio API Plugin * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Exact Globe - Alumio API Plugin **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select Exact Globe - Alumio API Plugin HTTP Client as the HTTP Client. 2. Fill in the Base URL and API Key. 3. You can optionally enable logging of request to get the log of the authentication. 4. Save the HTTP Client for use. Exact Globe connector screenshot 1 ### 2. Subscribing to Entities from Exact Globe - Alumio API Plugin **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Exact Globe - Alumio API Plugin Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from Exact Globe - Alumio API Plugin. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you will request from Exact Globe - Alumio API Plugin. 5. You can also optionally enable pagination to allow Alumio fetches paginated entities. 6. Select the Exact Globe - Alumio API Plugin HTTP Client to use. **2.2 General Concept** We follow Exact Globe - Alumio API Plugin documentation on building this connector, so you can easily use the connector based on [Exact Globe - Alumio API Plugin API Reference](https://demo-api.clickker.nl/swagger/ui/index#/). **Entity** The entity you want to subscribe to Exact Globe - Alumio API Plugin. Please refer to the entities from [Exact Globe - Alumio API Plugin API Reference](https://demo-api.clickker.nl/swagger/ui/index#/) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Exact Globe - Alumio API Plugin API Reference](https://demo-api.clickker.nl/swagger/ui/index#/). Please look at the example below on how to fill path field when subscribing ["Retrieve an item by Id."](https://demo-api.clickker.nl/swagger/ui/index#/Item/Item_GetById) entity. Exact Globe connector screenshot 2 Exact Globe connector screenshot 3 Based on the documentation, we can see that the end point require "Id" as a path. That is why we set the "Id" inside the path key in the Request Parameters. * Path is the path parameter of the url. For example the \{channelId}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then make a request to Exact Globe - Alumio API Plugin with the URL /api/Item/ById/1 **HTTP Client** The HTTP Client configuration you will use to access Exact Globe - Alumio API Plugin. ### 3. Publishing Entity to Exact Globe - Alumio API Plugin **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Exact Globe - Alumio API Plugin Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the Exact Globe - Alumio API Plugin entity you want the data to be published to. 4. You can optionally add any path data to the request on the key path. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. 7. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP POST method and HTTP PUT method on submitting data to Exact Globe - Alumio API Plugin. **Entity** We support publishing to most Exact Globe - Alumio API Plugin endpoints. Please refer to [Exact Globe - Alumio API Plugin API Reference](https://demo-api.clickker.nl/swagger/ui/index#/) page. For example, we want to create a new Sales Order. Please select “POST” as the Method and ["Create a new SalesOrder"](https://demo-api.clickker.nl/swagger/ui/index#/SalesOrder/SalesOrder_Post) as the entity of the publisher. Exact Globe connector screenshot 4 Exact Globe connector screenshot 5 Based on the documentation, we need to add a Body Request. So we put the body inside the payload key in the Data. Exact Globe connector screenshot 6 Alumio will send an API request to Exact Globe - Alumio API Plugin with URL /api/SalesOrder * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Exact Globe - Alumio API Plugin. # Exact Online Source: https://docs.alumio.com/connectors/exact-online Connect Alumio to Exact Online. ## Extra information System documentation: [Exact Online API Reference](https://start.exactonline.nl/docs/HlpRestAPIResources.aspx?SourceAction=10) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Exact Online * **1.1** Steps * **2.** Subscribing to entities from Exact Online * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Exact Online * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Exact Online **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client and select "Exact Online HTTP Client" as the HTTP Client. 2. Fill in the Base URI, Client ID, Client Secret, and Scopes (Optional). (For more information, see [Exact Online Reference](https://support.exactonline.com/community/s/knowledge-base#All-All-DNO-Content-gettingstarted)) 3. Click on "Grant access to Exact Online" to get the Key. 4. You can optionally enable logging of request to get the log of the authentication. 5. Save the HTTP Client for use. ### 2. Subscribing to Entities from Exact Online **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Exact Online Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from Exact Online. 3. Add any request parameters needed to subscribe to the entity. 4. You can optionally add a transformer to transform the request parameters into something you will request from Exact Online. 5. You can also optionally enable pagination to allow Alumio fetches paginated entities. 6. Select the Exact Online HTTP Client to use. **2.2 General Concept** We follow Exact Online documentation on building this connector, so you can easily use the connector based on [Exact Online API Reference](https://start.exactonline.nl/docs/HlpRestAPIResources.aspx?SourceAction=10). **Entity** The entity you want to subscribe to Exact Online. Please refer to the entities from [Exact Online API Reference](https://start.exactonline.nl/docs/HlpRestAPIResources.aspx?SourceAction=10) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Exact Online API Reference](https://start.exactonline.nl/docs/HlpRestAPIResources.aspx?SourceAction=10). Please look at the example below on how to fill path field when subscribing ["AccountOwners"](https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=AccountancyAccountOwners) entity. Exact Online connector screenshot 1 Exact Online connector screenshot 2 Based on the documentation, we can see that the end point require "division" as a path. That is why we set the "division" inside the path key in the Request Parameters. * Path is the path parameter of the url. For example the \{channelId}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) Alumio will then make a request to Exact Online with the URL /api/v1/3389687/accountancy/AccountOwners **HTTP Client** The HTTP Client configuration you will use to access Exact Online. ### 3. Publishing Entity to Exact Online **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Exact Online Publisher" as the publisher. 2. Select the Action that you want the publisher to perform with the data. 3. Select the Exact Online entity you want the data to be published to. 4. You can optionally add any path data to the request on the key path. 5. You can optionally add any query data to the request on the key query. 6. You can optionally add any payload data to the request on the key payload. 7. Select the HTTP Client to use. Exact Online connector screenshot 3 **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Create (HTTP POST method), Update (HTTP PUT method), Patch (HTTP PATCH method), and Delete (HTTP DELETE method) on submitting data to Exact Online. **Entity** We support publishing to most Exact Online endpoints. Please refer to [Exact Online API Reference](https://start.exactonline.nl/docs/HlpRestAPIResources.aspx?SourceAction=10) page. For example, we want to create owner of an account. Please select “Create” as the Action and ["AccountOwners"](https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=AccountancyAccountOwners) as the entity of the publisher. Exact Online connector screenshot 4 Exact Online connector screenshot 5 Based on the documentation, we can see that the end point require "division" as a path. That is why we set the "division" inside the path key in the Data. We also need to provide the body of the request, add it inside the payload key in the data. Exact Online connector screenshot 6 Alumio will send an API request to Exact Online with URL /api/v1/3389687/accountancy/AccountOwners * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Exact Online. # FashionMaster Source: https://docs.alumio.com/connectors/fashionmaster Connect Alumio to FashionMaster. ## Extra information System documentation: ## Connector package documentation # Setting up SOAP Client FashionMaster Retail ## Steps 1. In Alumio Dashboard, go to Clients > SOAP Clients. Create a new SOAP Client and select FashionMaster SOAP Client as the prototype of the SOAP Client. 2. Fill in the WSDL URI, Soap Version (Default is SOAP 1.1), and Storage for cache (Optional). 3. Save and Continue. Note: The authentications needs the Alumio IP to be whitelisted, to get the IP go to Settings > Info > Environment # Subscribing to Entities from FashionMaster Retail ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select FashionMaster Retail Subscriber as the subscriber. 2. Select the soap Method you want to subscribe to from FashionMaster Retail. 3. Add any request data needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the FashionMaster Retail SOAP Client to use. ## General Concept We follow FashionMaster Retail documentation on building this connector so you can easily use the connector based on FashionMaster Retail API Reference. **Entity** It’s the entity you want to subscribe to from FashionMaster Retail. Please refer to the entities in Management APIs from FashionMaster Retail API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on FashionMaster Retail API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing GetCustomerDetails entity FashionMaster connector screenshot 1 FashionMaster connector screenshot 2 **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **SOAP Client** It’s the SOAP Client configuration or prototype you will use to access FashionMaster Retail. # Publishing Entity to FashionMaster Retail ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select FashionMaster Retail Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the FashionMaster Retail entity you want the data to be published. 4. Select the SOAP Client to use. FashionMaster connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Entity** We support publishing to most FashionMaster Retail endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from the FashionMaster Retail API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a AmendCustomer. Please select “CreateAmendCustomer” as the entity of the publisher. FashionMaster connector screenshot 4 FashionMaster connector screenshot 5 Here is the example of the Payload in JSON that we tried. ``` { "Town": "Boryspil", "Email": "Alumiotest@test.com", "Title": "Mister", "County": "Maten", "Surname": "Smith", "Address1": "London", "Address2": "Kyiv", "Forename": "John", "PostCode": "1005", "Telephone1": "+44123456789", "Telephone2": "+380123456789", "CompanyName": "Alumio", "CountryCode": "44", "FMCustomerCode": "news", "WebCustomerCode": 33, "LoyaltyCardNumber": "123321", "WhereHeardAboutUs": 2, "WholesaleCustomer": false, "CustUpdateLog_User": "This customer is a test customer", "CustUpdateLog_Utility": "Facebook internation ads", "WhereHeardAboutUsSpecific": "Facebook Ads" } ``` You can put the payload you want to send to FashionMaster Retail into the payload property in the data. Here is an example of the Possible Response after Creation. FashionMaster connector screenshot 6 **SOAP Client** It’s the SOAP Client configuration or prototype you will use to access FashionMaster Retail. # FastSpring Source: https://docs.alumio.com/connectors/fastspring Connect Alumio to FastSpring. ## Extra information System documentation: \[FastSpring API Reference] **FastSpring** **Connector Package Documentation** # Setting up HTTP Client FastSpring ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select FastSpring HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, Username, and Password. * Save the Client for use later. # Subscribing to Entities from FastSpring ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select FastSpring Subscriber as the subscriber. * Select the entity you want to subscribe from FastSpring . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the FastSpring HTTP Client to use. ## General Concept We follow FastSpring documentation on building this connector so you can easily use the connector based on FastSpring API Reference. **Entity** It’s the entity you want to subscribe from FastSpring . Please refer to the entities in Management APIs from FastSpring API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on FastSpring API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Get an account. FastSpring connector screenshot 1 FastSpring connector screenshot 2 That’s why we need to define the **account\_id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Get an account. /accounts/Alumio **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access FastSpring . # Publishing Entity to FastSpring ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select FastSpring Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the FastSpring entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to FastSpring . * Select the HTTP Client to use. FastSpring connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most FastSpring endpoints. Please refer to the entities in Management APIs from the FastSpring API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a new account. Please select “Post” as the action and “Create an account” as the entity of the publisher. FastSpring connector screenshot 4 FastSpring connector screenshot 5 You can put the payload you want to send to FastSpring into the payload property in the data. Alumio will send an API request to FastSpring with URL /accounts **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access FastSpring . # FreeAgent Source: https://docs.alumio.com/connectors/freeagent Connect Alumio to FreeAgent. ## Extra information System documentation: [FreeAgent API Reference](https://dev.freeagent.com/docs/index) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client FreeAgent * **1.1** Steps * **2.** Subscribing to entities from FreeAgent * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to FreeAgent * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client FreeAgent **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select FreeAgent HTTP Client as PlatForm and click next step 3. Fill in the Base URI, Client ID and Client Secret. (For more information, see [FreeAgent Authentication Reference](https://dev.freeagent.com/docs/quick_start)) 4. Click on "Grant access to FreeAgent" and you will be redirected to approve the grant. 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. FreeAgent connector screenshot 1 ### 2. Subscribing to Entities from FreeAgent **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "FreeAgent Subscriber" as the subscriber. 2. Select the entity you want to subscribe to from FreeAgent. 3. Add any request parameters needed to subscribe to the entity. 4. Select the FreeAgent HTTP Client to use. 5. You can optionally add a transformer to transform the request parameters into something you will request from FreeAgent. 6. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow FreeAgent documentation on building this connector, so you can easily use the connector based on [FreeAgent API Reference](https://dev.freeagent.com/docs/index). **Entity** The entity you want to subscribe to FreeAgent. Please refer to the entities from [FreeAgent API Reference](https://dev.freeagent.com/docs/index) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [FreeAgent API Reference](https://dev.freeagent.com/docs/index) . Please look at the example below on how to fill path field when subscribing ["Contacts - Show Contact"](https://dev.freeagent.com/docs/contacts) entity. FreeAgent connector screenshot 2 FreeAgent connector screenshot 3 Based on the documentation, we can see that the end point require "id" as a parameter. That is why we set the "id" inside the path key in the Request Parameters. Alumio will then make a request to FreeAgent with the URL /v2/contacts/15978986 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access FreeAgent. ### 3. Publishing Entity to FreeAgent **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "FreeAgent Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the FreeAgent entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to FreeAgent. **Entity** We support publishing to most FreeAgent endpoints. Please refer to [FreeAgent API Reference](https://dev.freeagent.com/docs/index) page. For example, we want to add a new contact. Please select “Post” as the Method and ["Contacts - Create Contact"](https://dev.freeagent.com/docs/contacts) as the entity of the publisher. FreeAgent connector screenshot 4 FreeAgent connector screenshot 5 Based on the documentation, it requires a payload with root contact element. That is why we set the payload inside the payload key in the data with a root contact element. FreeAgent connector screenshot 6 Alumio will send an API request to FreeAgent with URL /v2/contacts Another example is when we want to delete a contact. Please select “Delete” as the Method and ["Contacts - Delete Contact"](https://dev.freeagent.com/docs/contacts) as the entity of the publisher. FreeAgent connector screenshot 7 FreeAgent connector screenshot 8 Based on the documentation, we can see that the end point require "id" as a parameter. That is why we set the "id" inside the path key in the Request Parameters. FreeAgent connector screenshot 9 Alumio will then make a request to FreeAgent with the URL /v2/contacts/15978986 * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: [www.url.com?type=true\&start=0](http://www.url.com?type=true\&start=0) * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access FreeAgent. # Freshbooks Source: https://docs.alumio.com/connectors/freshbooks Connect Alumio to Freshbooks. ## Extra information System documentation: ## Connector package documentation **Freshbooks** # Setting up HTTP Client Freshbooks ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Freshbooks HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Client ID, Client Secret and Scopes (Optional) 3. Press, “Grant Access to Freshbooks”. 4. Save the Client for use later. # Subscribing to Entities from Freshbooks ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Freshbooks Subscriber as the subscriber. 2. Select the entity you want to subscribe from Freshbooks. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Freshbooks HTTP Client to use. ## General Concept We follow Freshbooks documentation on building this connector so you can easily use the connector based on Freshbooks API Reference. **Entity** It’s the entity you want to subscribe from Freshbooks. Please refer to the entities in Management APIs from Freshbooks API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Freshbooks API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing List Clients entity Freshbooks connector screenshot 1 Freshbooks connector screenshot 2 That’s why we need to define the **accountId** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on List Clients entity. /accounting/account/3p54yo/users/clients **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Freshbooks. # Publishing Entity to Freshbooks ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Freshbooks Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Freshbooks entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Freshbooks. 6. Select the HTTP Client to use. Freshbooks connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method). **Entity** We support publishing to most Freshbooks endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from the Freshbooks API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create object. Please select “Post” as the action and “Create / Update Credit Note” as the entity of the publisher. Freshbooks connector screenshot 4 Freshbooks connector screenshot 5 You can put the payload you want to send to Freshbooks into the payload property in the data. Alumio will send an API request to Freshbooks with URL /accounting/account/3p54yo/credit\_notes/credit\_notes **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Freshbooks. # Freshdesk Source: https://docs.alumio.com/connectors/freshdesk Connect Alumio to Freshdesk. ## Extra information System documentation: ## Connector package documentation **Freshdesk** # Setting up HTTP Client Freshdesk ## Steps 1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Freshdesk HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, API Key/Email, and Password (Optional if you use API Key) 3. Save the Client for use later. # Setting up Credentials ## Steps 1. API Key * Log in to your Support Portal * Click on your profile picture on the top right corner of your portal * Go to Profile settings Page * Your API key will be available below the change password section to your right 2. Email & Password * Simply Register to the environment and use the same email and password that used to login into Freshdesk # Subscribing to Entities from Freshdesk ## Steps 1. Go to Connections -> Incoming and create a new incoming configuration and select Freshdesk Subscriber as the subscriber. 2. Select the entity you want to subscribe from Freshdesk. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the Freshdesk HTTP Client to use. ## General Concept We follow Freshdesk documentation on building this connector so you can easily use the connector based on Freshdesk API Reference. **Entity** It’s the entity you want to subscribe from Freshdesk. Please refer to the entities in Management APIs from Freshdesk API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on Freshdesk API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing View a Product entity. Freshdesk connector screenshot 1 Freshdesk connector screenshot 2 That’s why we need to define the **id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on View a Product. /api/v2/products/SS2B **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Freshdesk. # Publishing Entity to Freshdesk ## Steps 1. Go to Connections -> Outgoing, create a new outgoing configuration, and select Freshdesk Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the Freshdesk entity you want the data to be published. 4. You can optionally add any query parameters to the request. 5. You can also optionally add any transformers to transform the data into anything you need before submitting it to Freshdesk. 6. Select the HTTP Client to use. Freshdesk connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Action** Currently, we support Post (HTTP POST method), Patch (HTTP PATCH method), Put (HTTP PUT method). And Delete (HTTP DELETE method). **Entity** We support publishing to most Freshdesk endpoints. Please refer to the entities in Management APIs from the Freshdesk API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Delete a Contact. Please select “Delete” as the action and “Soft Delete a Contact” as the entity of the publisher. Freshdesk connector screenshot 4 Freshdesk connector screenshot 5 You can put the payload you want to send to Freshdesk into the payload property in the data. Alumio will send an API request to Freshdesk with URL /api/v2/contacts/123 **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access Freshdesk. # Google Calendar Source: https://docs.alumio.com/connectors/google-calendar Connect Alumio to Google Calendar. ## Extra information System documentation: [Google Calendar API Reference](https://developers.google.com/calendar/api/guides/overview) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Google Calendar * **1.1** Steps * **2.** Subscribing to entities from Google Calendar * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Google Calendar * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Google Calendar **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Google Calendar HTTP Client as PlatForm and click next step 3. Fill in the Base URI, Token URL, Authorize URL, Client ID, Client Secret and Scopes. (See the [Google Calendar Authentication Documentation](https://developers.google.com/calendar/api/auth) for more information) 4. Click on "Grant access to Google Calendar" and you will be redirected to Google Authentication to get the key for the client. 5. You can optionally enable logging of request to get the log of the authentication. 6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. Google Calendar connector screenshot 1 ### 2. Subscribing to Entities from Google Calendar **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Google Calendar Subscriber" as the subscriber. 2. Select the Method that you want the subscriber to fetch the data. 3. Select the entity you want to subscribe to from Google Calendar. 4. Add any request parameters needed to subscribe to the entity. 5. Select the Google Calendar HTTP Client to use. 6. You can optionally add a transformer to transform the request parameters into something you will request from Google Calendar. 7. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Google Calendar documentation on building this connector, so you can easily use the connector based on [Google Calendar API Reference](https://developers.google.com/calendar/api/guides/overview). **Entity** The entity you want to subscribe to Google Calendar. Please refer to the entities from [Google Calendar API Reference](https://developers.google.com/calendar/api/guides/overview) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Google Calendar API Reference](https://developers.google.com/calendar/api/guides/overview). Please look at the example below on how to fill path field when we want retrieve a Calendar by subscribing ["Calendar - Get Calendar"](https://developers.google.com/calendar/api/v3/reference/calendars/get) entity. Google Calendar connector screenshot 2 Google Calendar connector screenshot 3 From the end point, we can see that we need to set the calendar id as parameters. That is why we set the "calendarId" inside the path key in the Request Parameters. Alumio will then make a request to Google Calendar with the URL `/calendars/12345` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Google Calendar. ### 3. Publishing Entity to Google Calendar **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Google Calendar Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the Google Calendar entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method and HTTP Delete method on submitting data to Google Calendar. **Entity** We support publishing to most Google Calendar endpoints. Please refer to [Google Calendar API Reference](https://developers.google.com/calendar/api/guides/overview) page. For example, we want to create a calendar. Please select “Create data using POST” as the Method and ["Calendar - Create Calendar"](https://developers.google.com/calendar/api/v3/reference/calendars/insert). Google Calendar connector screenshot 4 Google Calendar connector screenshot 5 From the documentation, we can see that we need to set a body parameters. That is why we set the body parameters inside the payload key in the data. Google Calendar connector screenshot 6 Alumio will send an API request to Google Calendar with URL `/calendars` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Google Calendar. # Google Gemini Source: https://docs.alumio.com/connectors/google-gemini Connect Alumio to Google Gemini. ## Extra information System documentation: [Google Gemini API Reference](https://ai.google.dev/api/models) ## Connector package documentation ### Table of Contents * **1.** Setting up HTTP Client Google Gemini * **1.1** Steps * **2.** Subscribing to entities from Google Gemini * **2.1** Steps * **2.2** General concept * **3.** Publishing entity to Google Gemini * **3.1** Steps * **3.2** General concept ### 1. Setting up HTTP Client Google Gemini **1.1 Steps** 1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client. 2. Select Google Gemini HTTP Client as PlatForm and click next step 3. Fill in the Gemini API Keys. (See the [Google Gemini Authentication Documentation](https://ai.google.dev/gemini-api/docs/api-key) for more information) 4. You can optionally enable logging of request to get the log of the authentication. 5. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use. Google Gemini connector screenshot 1 ### 2. Subscribing to Entities from Google Gemini **2.1 Steps** 1. Go to Connections -> Incoming and create a new incoming configuration and select "Google Gemini Subscriber" as the subscriber. 2. Select the Method that you want the subscriber to get the data. 3. Select the entity you want to subscribe to from Google Gemini. 4. Add any request parameters needed to subscribe to the entity. 5. Select the Google Gemini HTTP Client to use. 6. You can optionally add a transformer to transform the request parameters into something you will request from Google Gemini. 7. You can also optionally enable pagination to allow Alumio fetches paginated entities. **2.2 General Concept** We follow Google Gemini documentation on building this connector, so you can easily use the connector based on [Google Gemini API Reference](https://ai.google.dev/api/models). **Entity** The entity you want to subscribe to Google Gemini. Please refer to the entities from [Google Gemini API Reference](https://ai.google.dev/api/models) page. **Request Parameters** These are the parameters you can provide to get the needed entity based on the [Google Gemini API Reference](https://ai.google.dev/api/models). Please look at the example below on how to fill path field when we want retrieve list comments by subscribing ["Method: models.get"](https://ai.google.dev/api/models) entity. Google Gemini connector screenshot 2 Google Gemini connector screenshot 3 From the end point, we can see that we need to set the model as parameters. That is why we set the "model" inside the path key in the Request Parameters. Alumio will then make a request to Google Gemini with the URL `https://generativelanguage.googleapis.com/v1beta/gemini-1.5-flash-latest` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Google Gemini. ### 3. Publishing Entity to Google Gemini **3.1 Steps** 1. Go to Connections -> Outgoing, create a new outgoing configuration and select "Google Gemini Publisher" as the publisher. 2. Select the Method that you want the publisher to perform with the data. 3. Select the Google Gemini entity you want the data to be published to. 4. You can optionally add any query data to the request on the key query. 5. You can optionally add any payload data to the request on the key payload. 6. Select the HTTP Client to use. **3.2 General Concept** Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support HTTP Post method, HTTP Patch method and HTTP Delete method on submitting data to Google Gemini. **Entity** We support publishing to most Google Gemini endpoints. Please refer to [Google Gemini API Reference](https://ai.google.dev/api/models) page. For example, we want to generate content by a model. Please select “Post” as the Method and ["Method: models.generateContent"](https://ai.google.dev/api/generate-content). Google Gemini connector screenshot 4 Google Gemini connector screenshot 5 From the documentation, we can see that we need to set a path parameter and a body parameters. That is why we set the "model" inside the path key and body parameters inside the payload key in the data. Google Gemini connector screenshot 6 Alumio will send an API request to Google Gemini with URL `https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash-latest:generateContent` * Path is the path parameter of the url. For example the \{id}. * Query is defined set of parameters attached to the end of a url.\ Example: `www.url.com?type=true&start=0` * Payload is the data contained within a request. **HTTP Client** The HTTP Client configuration you will use to access Google Gemini. # Google Merchant Source: https://docs.alumio.com/connectors/google-merchant Connect Alumio to Google Merchant. ## Extra information System documentation: ## Connector package documentation # Setting up HTTP Client [Google](https://google.com/) Merchant ## Steps 1. In Alumio Dashboard, go to Clients > HTTP Clients. Create a new HTTP Client and select [Google](https://google.com/) Merchant HTTP Client as the prototype of the HTTP Client. 2. Fill in the Base URI, Client ID, Client Secret, Code, and Scopes (optional). 3. Press “Grant access to [Google](https://google.com/) Merchant Center” and save. # Subscribing to Entities from [Google](https://google.com/) Merchant ## Steps 1. Go to Connections → Incoming and create a new incoming configuration and select [Google](https://google.com/) Merchant Subscriber as the subscriber. 2. Select the entity you want to subscribe from [Google](https://google.com/) Merchant. 3. Add any request parameters needed to subscribe to the entity (optional). 4. You can optionally add a transformer to transform the request parameters into something you need. 5. Select the [Google](https://google.com/) Merchant HTTP Client to use. ## General Concept We follow [Google](https://google.com/) Merchant documentation on building this connector so you can easily use the connector based on [Google](https://google.com/) Merchant API Reference. **Entity** It’s the entity you want to subscribe from [Google](https://google.com/) Merchant. Please refer to the entities in Management APIs from the [Google](https://google.com/) Merchant API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on [Google](https://google.com/) Merchant API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing to accounts.get entity. Google Merchant connector screenshot 1 Google Merchant connector screenshot 2 That’s why we need to define **merchantId and accountId** properties inside the **path** property in the Request Parameters field. The properties inside **query** parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on accounts.get entity. /content/v2.1/1/accounts/1 **Input Transformer** Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access [Google](https://google.com/) Merchant. # Publishing Entity to [Google](https://google.com/) Merchant ## Steps 1. Go to Connections → Outgoing, create a new outgoing configuration, and select [Google](https://google.com/) Merchant Publisher as the publisher. 2. Select the action that you want the publisher to do with the data. 3. Select the [Google](https://google.com/) Merchant entity you want the data to be published. 4. Select the HTTP Client to use. Google Merchant connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration). **Action** Currently, we support Create (HTTP POST method), Put (HTTP PUT method),Patch (HTTP PATCH method), and Delete (HTTP DELETE method). **Entity** We support publishing to most [Google](https://google.com/) Merchant endpoints. Please refer to the entities in Management APIs from the [Google](https://google.com/) Merchant API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Accounts. Please select “Create” as the action and “accounts. insert” as the entity of the publisher. Google Merchant connector screenshot 4 Google Merchant connector screenshot 5 You can put the payload you want to send to [Google](https://google.com/) Merchant into the payload property in the data. Alumio will send an API request to [Google](https://google.com/) Merchant with URL /content/v2.1/1/accounts **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access [Google](https://google.com/) Merchant. # Important Notes **Documentation Mistake** * Product insert: the parameter “offerId” is needed and this is not mentioned in the documentation. Also the documentation mentions that we should insert the parameters in this format for example: “image\_link” but it should be “imageLink” and for example the as per the documentation it says “is\_bundle” but the parameter should be “isBundle”. This goes for all parameters. * Create Region: The payload should have the following parameters unlike the documentation ``` { "displayname": "TestRegion_Alumio", "postalCodeArea": { "regionCode": "US", "postalCodes": [ { "end": "98112", "begin": "98064" } ] }, "shippingEligible" : true, "regionalInventoryEligible" : true } ``` # HaloITSM Source: https://docs.alumio.com/connectors/haloitsm Connect Alumio to HaloITSM. ## Extra information System documentation: \[HaloITSM API Reference] # Setting up HTTP Client HaloITSM ## Steps * In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select HaloITSM HTTP Client as the prototype of the HTTP Client. * Fill in the Base URI, Authentication type. * Username & Password : Fill in Client ID, Username, Password, and Scopes. * Client Credentials : Fill in Client ID, Client Secret, and Scopes. * Save the Client for use later. Currently we Support only Username & Password, and Client Credentials for Authentication. # Subscribing to Entities from HaloITSM ## Steps * Go to Connections -> Incoming and create a new incoming configuration and select HaloITSM Subscriber as the subscriber. * Select the entity you want to subscribe from HaloITSM . * Add any request parameters needed to subscribe to the entity (optional). * You can optionally add a transformer to transform the request parameters into something you need. * Select the HaloITSM HTTP Client to use. ## General Concept We follow HaloITSM documentation on building this connector so you can easily use the connector based on HaloITSM API Reference. **Entity** It’s the entity you want to subscribe from HaloITSM . Please refer to the entities in Management APIs from HaloITSM API Reference page. **Request Parameters** These are the parameters you can provide to get the needed entity based on HaloITSM API Reference. Please look at the example below on how to fill the Request Parameters field when Returns a single action object. HaloITSM connector screenshot 1 HaloITSM connector screenshot 2 That’s why we need to define the **id** property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on Returns a single action object. /Actions/AC12 **Input Transformer** Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity. **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access HaloITSM . # Publishing Entity to HaloITSM ## Steps * Go to Connections -> Outgoing, create a new outgoing configuration, and select HaloITSM Publisher as the publisher. * Select the action that you want the publisher to do with the data. * Select the HaloITSM entity you want the data to be published. * You can optionally add any query parameters to the request. * You can also optionally add any transformers to transform the data into anything you need before submitting it to HaloITSM . * Select the HTTP Client to use. HaloITSM connector screenshot 3 ## General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. **Method** Currently, we support Post (HTTP POST method), and Delete (HTTP DELETE method). **Entity** We support publishing to most HaloITSM endpoints. Please refer to the entities in Management APIs from the HaloITSM API Reference page. Based on the documentation, some endpoints may need one or more path parameters. For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a new assets. Please select “Post” as the action and “Adds or updates one or more Assets…….” as the entity of the publisher. HaloITSM connector screenshot 4 HaloITSM connector screenshot 5 You can put the payload you want to send to HaloITSM into the payload property in the data. Alumio will send an API request to HaloITSM with URL /Assets **HTTP Client** It’s the HTTP Client configuration or prototype you will use to access HaloITSM . # How to use connector packages Source: https://docs.alumio.com/connectors/how-to-use A general guide to using any Alumio connector package: incoming and outgoing configurations, and request parameters. ## Introduction If you have been using Alumio, you would know that connections across various data points play an important role in many operational scenarios. From retrieving products/collections to getting product variants and much more, the Alumio connector package allows you to establish connections smoothly. This article will shed light on how to establish a connection with any of the platforms that you would like to connect with. Let's suppose that you have a Shopify connector that you would like to integrate with the help of Alumio. You can name it Shopify- Get Products Connector Package. To begin with, you must start with creating a template within the Incoming Configuration.