WebhookApi
- List Event Logs
- Create Webhook Subscription
- List Webhook Subscriptions
- Delete Webhook Subscription
- Get Webhook Subscription
- Update Webhook Subscription
Method: eventLogsAll
Apideck->getWebhookApi()->eventLogsAll($data)| Name | Type | Description | Notes |
|---|---|---|---|
| x_apideck_app_id | string | The ID of your Unify application | |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
| filter | \Apideck\Client\Model\WebhookEventLogsFilter | Filter results | |
| limit | [int] | Number of results to return. Minimum 1, Maximum 200, Default 20 | (optional) defaults to 20 |
\Apideck\Client\Model\GetWebhookEventLogsResponse
| Status code | Description |
|---|---|
| 200 | EventLogs |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 422 | Unprocessable |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getWebhookApi()->eventLogsAll();
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: webhooksAdd
Apideck->getWebhookApi()->webhooksAdd($data)| Name | Type | Description | Notes |
|---|---|---|---|
| create_webhook_request | \Apideck\Client\Model\CreateWebhookRequest | ||
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\CreateWebhookResponse
| Status code | Description |
|---|---|
| 201 | Webhooks |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 422 | Unprocessable |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getWebhookApi()->webhooksAdd($webhook);
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: webhooksAll
Apideck->getWebhookApi()->webhooksAll($data)| Name | Type | Description | Notes |
|---|---|---|---|
| x_apideck_app_id | string | The ID of your Unify application | |
| cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
| limit | [int] | Number of results to return. Minimum 1, Maximum 200, Default 20 | (optional) defaults to 20 |
\Apideck\Client\Model\GetWebhooksResponse
| Status code | Description |
|---|---|
| 200 | Webhooks |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 422 | Unprocessable |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getWebhookApi()->webhooksAll();
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: webhooksDelete
Apideck->getWebhookApi()->webhooksDelete($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | |
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\DeleteWebhookResponse
| Status code | Description |
|---|---|
| 200 | Webhooks |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 422 | Unprocessable |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getWebhookApi()->webhooksDelete('id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: webhooksOne
Apideck->getWebhookApi()->webhooksOne($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | |
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\GetWebhookResponse
| Status code | Description |
|---|---|
| 200 | Webhooks |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 422 | Unprocessable |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getWebhookApi()->webhooksOne('id_example');
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}[Back to top] [Back to API list] [Back to README]
Method: webhooksUpdate
Apideck->getWebhookApi()->webhooksUpdate($data)| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | |
| update_webhook_request | \Apideck\Client\Model\UpdateWebhookRequest | ||
| x_apideck_app_id | string | The ID of your Unify application |
\Apideck\Client\Model\UpdateWebhookResponse
| Status code | Description |
|---|---|
| 200 | Webhooks |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 404 | The specified resource was not found |
| 422 | Unprocessable |
| 4/5xx | Unexpected error |
<?php
require('vendor/autoload.php');
use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;
$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');
$apideck = new Apideck($config);
try {
$response = $apideck->getWebhookApi()->webhooksUpdate('id_example', $webhook);
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}