Svix\ApiClient\IntegrationApi

All URIs are relative to https://api.eu.svix.com, except if the operation defines another base path.

Method	HTTP request	Description
v1IntegrationCreate()	POST /api/v1/app/{app_id}/integration/	Create Integration
v1IntegrationDelete()	DELETE /api/v1/app/{app_id}/integration/{integ_id}/	Delete Integration
v1IntegrationGet()	GET /api/v1/app/{app_id}/integration/{integ_id}/	Get Integration
v1IntegrationGetKey()	GET /api/v1/app/{app_id}/integration/{integ_id}/key/	Get Integration Key
v1IntegrationList()	GET /api/v1/app/{app_id}/integration/	List Integrations
v1IntegrationRotateKey()	POST /api/v1/app/{app_id}/integration/{integ_id}/key/rotate/	Rotate Integration Key
v1IntegrationUpdate()	PUT /api/v1/app/{app_id}/integration/{integ_id}/	Update Integration

`v1IntegrationCreate()`

v1IntegrationCreate($app_id, $integration_in, $idempotency_key): \Svix\ApiClient\Model\IntegrationOut

Create Integration

Create an integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$integration_in = new \Svix\ApiClient\Model\IntegrationIn(); // \Svix\ApiClient\Model\IntegrationIn
$idempotency_key = 'idempotency_key_example'; // string | The request's idempotency key

try {
    $result = $apiInstance->v1IntegrationCreate($app_id, $integration_in, $idempotency_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	The app's ID or UID
integration_in	\Svix\ApiClient\Model\IntegrationIn
idempotency_key	string	The request's idempotency key	[optional]

Return type

\Svix\ApiClient\Model\IntegrationOut

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v1IntegrationDelete()`

v1IntegrationDelete($app_id, $integ_id)

Delete Integration

Delete an integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$integ_id = integ_1srOrx2ZWZBpBUvZwXKQmoEYga2; // string | The integ's ID

try {
    $apiInstance->v1IntegrationDelete($app_id, $integ_id);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	The app's ID or UID
integ_id	string	The integ's ID

Return type

void (empty response body)

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v1IntegrationGet()`

v1IntegrationGet($app_id, $integ_id): \Svix\ApiClient\Model\IntegrationOut

Get Integration

Get an integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$integ_id = integ_1srOrx2ZWZBpBUvZwXKQmoEYga2; // string | The integ's ID

try {
    $result = $apiInstance->v1IntegrationGet($app_id, $integ_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	The app's ID or UID
integ_id	string	The integ's ID

Return type

\Svix\ApiClient\Model\IntegrationOut

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v1IntegrationGetKey()`

v1IntegrationGetKey($app_id, $integ_id): \Svix\ApiClient\Model\IntegrationKeyOut

Get Integration Key

Get an integration's key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$integ_id = integ_1srOrx2ZWZBpBUvZwXKQmoEYga2; // string | The integ's ID

try {
    $result = $apiInstance->v1IntegrationGetKey($app_id, $integ_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationGetKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	The app's ID or UID
integ_id	string	The integ's ID

Return type

\Svix\ApiClient\Model\IntegrationKeyOut

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v1IntegrationList()`

v1IntegrationList($app_id, $limit, $iterator): \Svix\ApiClient\Model\ListResponseIntegrationOut

List Integrations

List the application's integrations.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$limit = 56; // int | Limit the number of returned items
$iterator = integ_1srOrx2ZWZBpBUvZwXKQmoEYga2; // string | The iterator returned from a prior invocation

try {
    $result = $apiInstance->v1IntegrationList($app_id, $limit, $iterator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	The app's ID or UID
limit	int	Limit the number of returned items	[optional]
iterator	string	The iterator returned from a prior invocation	[optional]

Return type

\Svix\ApiClient\Model\ListResponseIntegrationOut

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v1IntegrationRotateKey()`

v1IntegrationRotateKey($app_id, $integ_id, $idempotency_key): \Svix\ApiClient\Model\IntegrationKeyOut

Rotate Integration Key

Rotate the integration's key. The previous key will be immediately revoked.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$integ_id = integ_1srOrx2ZWZBpBUvZwXKQmoEYga2; // string | The integ's ID
$idempotency_key = 'idempotency_key_example'; // string | The request's idempotency key

try {
    $result = $apiInstance->v1IntegrationRotateKey($app_id, $integ_id, $idempotency_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationRotateKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
app_id	string	The app's ID or UID
integ_id	string	The integ's ID
idempotency_key	string	The request's idempotency key	[optional]

Return type

\Svix\ApiClient\Model\IntegrationKeyOut

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`v1IntegrationUpdate()`

v1IntegrationUpdate($app_id, $integ_id, $integration_update): \Svix\ApiClient\Model\IntegrationOut

Update Integration

Update an integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: HTTPBearer
$config = Svix\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Svix\ApiClient\Api\IntegrationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = unique-app-identifier; // string | The app's ID or UID
$integ_id = integ_1srOrx2ZWZBpBUvZwXKQmoEYga2; // string | The integ's ID
$integration_update = new \Svix\ApiClient\Model\IntegrationUpdate(); // \Svix\ApiClient\Model\IntegrationUpdate

try {
    $result = $apiInstance->v1IntegrationUpdate($app_id, $integ_id, $integration_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IntegrationApi->v1IntegrationUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
app_id	string	The app's ID or UID
integ_id	string	The integ's ID
integration_update	\Svix\ApiClient\Model\IntegrationUpdate

Return type

\Svix\ApiClient\Model\IntegrationOut

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

IntegrationApi.md

Latest commit

History

IntegrationApi.md

File metadata and controls

Svix\ApiClient\IntegrationApi

v1IntegrationCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

v1IntegrationDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

v1IntegrationGet()

Example

Parameters

Return type

Authorization

HTTP request headers

v1IntegrationGetKey()

Example

Parameters

Return type

Authorization

HTTP request headers

v1IntegrationList()

Example

Parameters

Return type

Authorization

HTTP request headers

v1IntegrationRotateKey()

Example

Parameters

Return type

Authorization

HTTP request headers

v1IntegrationUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`v1IntegrationCreate()`

`v1IntegrationDelete()`

`v1IntegrationGet()`

`v1IntegrationGetKey()`

`v1IntegrationList()`

`v1IntegrationRotateKey()`

`v1IntegrationUpdate()`