HooksApi.md

Swagger\Client\HooksApi

All URIs are relative to https://api.meltwater.com

Method	HTTP request	Description
createHook	POST /v2/hooks	Creates a hook for one of your predefined searches.
deleteHook	DELETE /v2/hooks/{hook_id}	Delete an existing hook.
getAllHooks	GET /v2/hooks	List all hooks.

createHook

\Swagger\Client\Model\Hook createHook($user_key, $authorization, $v2_hooks, $x_hook_secret)

Creates a hook for one of your predefined searches.

Creates a hook for one of your predefined searches. Delivers search results for the query referenced by the search_id to the target_url via HTTP POST. Note that a hook_id will be returned on successful creation, this id is needed to delete the hook. We are also returning the header: X-Hook-Secret, a shared secret used to sign the document body pushed to your target_url. Requires an OAuth access token.

Example

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

$api_instance = new Swagger\Client\Api\HooksApi();
$user_key = "user_key_example"; // string | The `user_key` from [developer.meltwater.com](https://developer.meltwater.com/admin/applications/).
$authorization = "authorization_example"; // string | `Oauth Access Token`    OAuth access token (RFC 6749). Must contain the access token type `Bearer`  followed by an OAuth access token.    #### Example:        Bearer KKwmfHwxsEoeMDTMAfxOpO...
$v2_hooks = new \Swagger\Client\Model\PostV2Hooks(); // \Swagger\Client\Model\PostV2Hooks | 
$x_hook_secret = "x_hook_secret_example"; // string | Shared secret for content signing/verification.    The shared secret header is optional and can be provided by the user or will  be set by the API. Must be between 16 and 64 characters.  Obtain the shared secret from the response header `X-Hook-Secret`.    #### Example:        e2d264b524240b9572ebc2fc7eebd980

try {
    $result = $api_instance->createHook($user_key, $authorization, $v2_hooks, $x_hook_secret);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HooksApi->createHook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user_key	string	The `user_key` from developer.meltwater.com.
authorization	string	`Oauth Access Token` OAuth access token (RFC 6749). Must contain the access token type `Bearer` followed by an OAuth access token. #### Example: Bearer KKwmfHwxsEoeMDTMAfxOpO...
v2_hooks	\Swagger\Client\Model\PostV2Hooks
x_hook_secret	string	Shared secret for content signing/verification. The shared secret header is optional and can be provided by the user or will be set by the API. Must be between 16 and 64 characters. Obtain the shared secret from the response header `X-Hook-Secret`. #### Example: e2d264b524240b9572ebc2fc7eebd980	[optional]

Return type

\Swagger\Client\Model\Hook

Authorization

No authorization required

HTTP request headers

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

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

deleteHook

deleteHook($user_key, $authorization, $hook_id)

Delete an existing hook.

Delete an existing hook. Removes the hook and stops sending any search results to the target_url. Requires an OAuth access token.

Example

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

$api_instance = new Swagger\Client\Api\HooksApi();
$user_key = "user_key_example"; // string | The `user_key` from [developer.meltwater.com](https://developer.meltwater.com/admin/applications/).
$authorization = "authorization_example"; // string | `Oauth Access Token`    OAuth access token (RFC 6749). Must contain the access token type `Bearer`  followed by an OAuth access token.    #### Example:        Bearer KKwmfHwxsEoeMDTMAfxOpO...
$hook_id = "hook_id_example"; // string | Hook ID received from creating a hook

try {
    $api_instance->deleteHook($user_key, $authorization, $hook_id);
} catch (Exception $e) {
    echo 'Exception when calling HooksApi->deleteHook: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user_key	string	The `user_key` from developer.meltwater.com.
authorization	string	`Oauth Access Token` OAuth access token (RFC 6749). Must contain the access token type `Bearer` followed by an OAuth access token. #### Example: Bearer KKwmfHwxsEoeMDTMAfxOpO...
hook_id	string	Hook ID received from creating a hook

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getAllHooks

\Swagger\Client\Model\HooksCollection getAllHooks($user_key, $authorization)

List all hooks.

List all hooks. Delivers all previously generated hooks. Requires an OAuth access token.

Example

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

$api_instance = new Swagger\Client\Api\HooksApi();
$user_key = "user_key_example"; // string | The `user_key` from [developer.meltwater.com](https://developer.meltwater.com/admin/applications/).
$authorization = "authorization_example"; // string | `Oauth Access Token`    OAuth access token (RFC 6749). Must contain the access token type `Bearer`  followed by an OAuth access token.    #### Example:        Bearer KKwmfHwxsEoeMDTMAfxOpO...

try {
    $result = $api_instance->getAllHooks($user_key, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HooksApi->getAllHooks: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user_key	string	The `user_key` from developer.meltwater.com.
authorization	string	`Oauth Access Token` OAuth access token (RFC 6749). Must contain the access token type `Bearer` followed by an OAuth access token. #### Example: Bearer KKwmfHwxsEoeMDTMAfxOpO...

Return type

\Swagger\Client\Model\HooksCollection

Authorization

No authorization required

HTTP request headers

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

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