Skip to content

HubSpotApi.md

Latest commit

 

History

History
304 lines (204 loc) · 9.09 KB

HubSpotApi.md

File metadata and controls

304 lines (204 loc) · 9.09 KB

SynergiTech\Cinolla\HubSpotApi

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

Method HTTP request Description
disconnectHubSpot() POST /v3/client/hubspot/disconnect Disconnect HubSpot integration
getHubSpotConnectionStatus() GET /v3/client/hubspot/status Check HubSpot connection status
getHubSpotOAuthUrl() GET /v3/client/hubspot/oauth/authorize Get the HubSpot OAuth authorization URL
handleHubSpotOAuthCallback() GET /v3/client/hubspot/oauth/callback Handle the HubSpot OAuth callback
handleHubSpotWebhook() POST /v3/client/hubspot/webhooks Receive and process HubSpot webhook events

disconnectHubSpot()

disconnectHubSpot(): \SynergiTech\Cinolla\Model\DisconnectHubSpot200Response

Disconnect HubSpot integration

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\HubSpotApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Cinolla\Model\DisconnectHubSpot200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getHubSpotConnectionStatus()

getHubSpotConnectionStatus(): \SynergiTech\Cinolla\Model\GetHubSpotConnectionStatus200Response

Check HubSpot connection status

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\HubSpotApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Cinolla\Model\GetHubSpotConnectionStatus200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getHubSpotOAuthUrl()

getHubSpotOAuthUrl(): \SynergiTech\Cinolla\Model\GetHubSpotOAuthUrl200Response

Get the HubSpot OAuth authorization URL

Redirect the customer to this URL to begin the OAuth flow.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\HubSpotApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Cinolla\Model\GetHubSpotOAuthUrl200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

handleHubSpotOAuthCallback()

handleHubSpotOAuthCallback($code): \SynergiTech\Cinolla\Model\HandleHubSpotOAuthCallback200Response

Handle the HubSpot OAuth callback

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\HubSpotApi(
    // 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
);
$code = 'code_example'; // string | The authorization code from HubSpot

try {
    $result = $apiInstance->handleHubSpotOAuthCallback($code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HubSpotApi->handleHubSpotOAuthCallback: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
code string The authorization code from HubSpot

Return type

\SynergiTech\Cinolla\Model\HandleHubSpotOAuthCallback200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

handleHubSpotWebhook()

handleHubSpotWebhook(): \SynergiTech\Cinolla\Model\HandleHubSpotWebhook200Response

Receive and process HubSpot webhook events

This is a public endpoint (no Cinolla auth required). Requests are verified using HubSpot's X-HubSpot-Signature-v3 header. The company is resolved from the portalId in the webhook payload.

Example

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


// Configure API key authorization: ApiKeyAuth
$config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SynergiTech\Cinolla\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new SynergiTech\Cinolla\Api\HubSpotApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Cinolla\Model\HandleHubSpotWebhook200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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