keboola/sync-actions-client

Sync actions PHP Client

4.0.0 2026-07-09 09:31 UTC

Requires

• php: ^8.4
• guzzlehttp/guzzle: ^7.8
• keboola/php-api-client-base: *@dev
• psr/log: ^3.0
• webmozart/assert: ^1.11

Requires (Dev)

• keboola/coding-standard: >=16.0
• keboola/php-temp: ^2.0
• monolog/monolog: ^3.9
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.3
• symfony/dotenv: ^7.3
• symfony/process: ^7.3

MIT

• Keboola

• php
• api
• client
• keboola
• sync-actions

Published on Packagist.org on 2026-07-19 14:16 UTC

README

PHP client for the Keboola sync actions API, built on top of keboola/php-api-client-base.

Usage

composer require keboola/sync-actions-client

use Keboola\SyncActionsClient\ActionData;
use Keboola\SyncActionsClient\SyncActionsApiClient;

$client = new SyncActionsApiClient(
    'https://sync-actions.keboola.com/',
    'xxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
);

// Invoke a component action; $response->data is a stdClass with the raw action payload.
$response = $client->callAction(new ActionData(
    'keboola.ex-db-snowflake',
    'getTables',
));
var_dump($response->data);

// List the actions a component exposes.
$actions = $client->getActions('keboola.ex-db-snowflake');
var_dump($actions->actions);

Failures throw Keboola\SyncActionsClient\Exception\SyncActionsClientException.

Development

Clone this repository and init the workspace with following command:

git clone https://github.com/keboola/sync-actions-api-php-client
cd sync-actions-api-php-client
docker-compose build
docker-compose run --rm dev composer install --no-scripts

Create .env.local file with following contents:

HOSTNAME_SUFFIX=keboola.com
STORAGE_API_TOKEN=xxx-xxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Run the test suite using this command:

docker-compose run --rm dev composer tests

Integration

For information about deployment and integration with KBC, please refer to the deployment section of developers documentation