Flipdish\Client\WebhooksApi

All URIs are relative to https://api.flipdish.co

Method	HTTP request	Description
createWebhookSubscription	POST /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions
createWebhookSubscriptionEventNames	POST /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}
deleteWebhookSubscription	DELETE /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}
deleteWebhookSubscriptionEventName	DELETE /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}
getWebhookEventNames	GET /api/v1.0/{appId}/webhooks/events
getWebhookEventNamesBySubscriptionId	GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events
getWebhookEventSample	GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/events/{eventName}/test
getWebhookLogs	GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}/logs
getWebhookSubscriptions	GET /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions
updateWebhookSubscription	PUT /api/v1.0/{appId}/webhooks/{oauthAppId}/subscriptions/{webhookSubscriptionId}

createWebhookSubscription

\Flipdish\Client\Models\RestApiIntegerResult createWebhookSubscription($oauth_app_id, $webhook_subscription, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription = new \Flipdish\\Client\Models\WebhookSubscription(); // \Flipdish\\Client\Models\WebhookSubscription | 
$app_id = "app_id_example"; // string | 

try {
    $result = $apiInstance->createWebhookSubscription($oauth_app_id, $webhook_subscription, $app_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->createWebhookSubscription: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
oauth_app_id	string
webhook_subscription	\Flipdish\Client\Models\WebhookSubscription
app_id	string

Return type

\Flipdish\Client\Models\RestApiIntegerResult

Authorization

oauth2

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

createWebhookSubscriptionEventNames

createWebhookSubscriptionEventNames($oauth_app_id, $webhook_subscription_id, $event_name, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = 56; // int | 
$event_name = "event_name_example"; // string | 
$app_id = "app_id_example"; // string | 

try {
    $apiInstance->createWebhookSubscriptionEventNames($oauth_app_id, $webhook_subscription_id, $event_name, $app_id);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->createWebhookSubscriptionEventNames: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
oauth_app_id	string
webhook_subscription_id	int
event_name	string
app_id	string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

deleteWebhookSubscription

deleteWebhookSubscription($oauth_app_id, $webhook_subscription_id, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = 56; // int | 
$app_id = "app_id_example"; // string | 

try {
    $apiInstance->deleteWebhookSubscription($oauth_app_id, $webhook_subscription_id, $app_id);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->deleteWebhookSubscription: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
oauth_app_id	string
webhook_subscription_id	int
app_id	string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

deleteWebhookSubscriptionEventName

deleteWebhookSubscriptionEventName($oauth_app_id, $webhook_subscription_id, $event_name, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = 56; // int | 
$event_name = "event_name_example"; // string | 
$app_id = "app_id_example"; // string | 

try {
    $apiInstance->deleteWebhookSubscriptionEventName($oauth_app_id, $webhook_subscription_id, $event_name, $app_id);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->deleteWebhookSubscriptionEventName: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
oauth_app_id	string
webhook_subscription_id	int
event_name	string
app_id	string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getWebhookEventNames

\Flipdish\Client\Models\RestApiStringArrayResult getWebhookEventNames($app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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 = "app_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\RestApiStringArrayResult

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getWebhookEventNamesBySubscriptionId

\Flipdish\Client\Models\RestApiStringArrayResult getWebhookEventNamesBySubscriptionId($oauth_app_id, $webhook_subscription_id, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = 56; // int | 
$app_id = "app_id_example"; // string | 

try {
    $result = $apiInstance->getWebhookEventNamesBySubscriptionId($oauth_app_id, $webhook_subscription_id, $app_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhookEventNamesBySubscriptionId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
oauth_app_id	string
webhook_subscription_id	int
app_id	string

Return type

\Flipdish\Client\Models\RestApiStringArrayResult

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getWebhookEventSample

\Flipdish\Client\Models\WebhookEventSample getWebhookEventSample($event_name, $app_id, $oauth_app_id, $webhook_subscription_id, $version)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$event_name = "event_name_example"; // string | 
$app_id = "app_id_example"; // string | 
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = "webhook_subscription_id_example"; // string | 
$version = "version_example"; // string | 

try {
    $result = $apiInstance->getWebhookEventSample($event_name, $app_id, $oauth_app_id, $webhook_subscription_id, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhookEventSample: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
event_name	string
app_id	string
oauth_app_id	string
webhook_subscription_id	string
version	string	[optional]

Return type

\Flipdish\Client\Models\WebhookEventSample

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getWebhookLogs

\Flipdish\Client\Models\RestApiPaginationResultWebhookLog getWebhookLogs($oauth_app_id, $webhook_subscription_id, $start, $end, $app_id, $page, $limit)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = 56; // int | 
$start = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$end = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$app_id = "app_id_example"; // string | 
$page = 56; // int | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getWebhookLogs($oauth_app_id, $webhook_subscription_id, $start, $end, $app_id, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhookLogs: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
oauth_app_id	string
webhook_subscription_id	int
start	\DateTime
end	\DateTime
app_id	string
page	int	[optional]
limit	int	[optional]

Return type

\Flipdish\Client\Models\RestApiPaginationResultWebhookLog

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

getWebhookSubscriptions

\Flipdish\Client\Models\RestApiPaginationResultWebhookSubscription getWebhookSubscriptions($oauth_app_id, $app_id, $page, $limit)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$app_id = "app_id_example"; // string | 
$page = 56; // int | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getWebhookSubscriptions($oauth_app_id, $app_id, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhookSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Notes
oauth_app_id	string
app_id	string
page	int	[optional]
limit	int	[optional]

Return type

\Flipdish\Client\Models\RestApiPaginationResultWebhookSubscription

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

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

updateWebhookSubscription

updateWebhookSubscription($oauth_app_id, $webhook_subscription_id, $webhook_subscription, $app_id)

Example

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

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\WebhooksApi(
    // 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
);
$oauth_app_id = "oauth_app_id_example"; // string | 
$webhook_subscription_id = 56; // int | 
$webhook_subscription = new \Flipdish\\Client\Models\WebhookSubscription(); // \Flipdish\\Client\Models\WebhookSubscription | 
$app_id = "app_id_example"; // string | 

try {
    $apiInstance->updateWebhookSubscription($oauth_app_id, $webhook_subscription_id, $webhook_subscription, $app_id);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->updateWebhookSubscription: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
oauth_app_id	string
webhook_subscription_id	int
webhook_subscription	\Flipdish\Client\Models\WebhookSubscription
app_id	string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

FilesExpand file tree

WebhooksApi.md

Latest commit

History

WebhooksApi.md

File metadata and controls

Flipdish\Client\WebhooksApi

createWebhookSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

createWebhookSubscriptionEventNames

Example

Parameters

Return type

Authorization

HTTP request headers

deleteWebhookSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

deleteWebhookSubscriptionEventName

Example

Parameters

Return type

Authorization

HTTP request headers

getWebhookEventNames

Example

Parameters

Return type

Authorization

HTTP request headers

getWebhookEventNamesBySubscriptionId

Example

Parameters

Return type

Authorization

HTTP request headers

getWebhookEventSample

Example

Parameters

Return type

Authorization

HTTP request headers

getWebhookLogs

Example

Parameters

Return type

Authorization

HTTP request headers

getWebhookSubscriptions

Example

Parameters

Return type

Authorization

HTTP request headers

updateWebhookSubscription

Example

Parameters

Return type

Authorization

HTTP request headers