WebhooksApi
WebhooksApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createNetworkWebhooksHttpServer() : object
- Operation createNetworkWebhooksHttpServer
- createNetworkWebhooksHttpServerAsync() : PromiseInterface
- Operation createNetworkWebhooksHttpServerAsync
- createNetworkWebhooksHttpServerAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkWebhooksHttpServerAsyncWithHttpInfo
- createNetworkWebhooksHttpServerWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkWebhooksHttpServerWithHttpInfo
- createNetworkWebhooksWebhookTest() : object
- Operation createNetworkWebhooksWebhookTest
- createNetworkWebhooksWebhookTestAsync() : PromiseInterface
- Operation createNetworkWebhooksWebhookTestAsync
- createNetworkWebhooksWebhookTestAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkWebhooksWebhookTestAsyncWithHttpInfo
- createNetworkWebhooksWebhookTestWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkWebhooksWebhookTestWithHttpInfo
- deleteNetworkWebhooksHttpServer() : void
- Operation deleteNetworkWebhooksHttpServer
- deleteNetworkWebhooksHttpServerAsync() : PromiseInterface
- Operation deleteNetworkWebhooksHttpServerAsync
- deleteNetworkWebhooksHttpServerAsyncWithHttpInfo() : PromiseInterface
- Operation deleteNetworkWebhooksHttpServerAsyncWithHttpInfo
- deleteNetworkWebhooksHttpServerWithHttpInfo() : array<string|int, mixed>
- Operation deleteNetworkWebhooksHttpServerWithHttpInfo
- getConfig() : Configuration
- getNetworkWebhooksHttpServer() : object
- Operation getNetworkWebhooksHttpServer
- getNetworkWebhooksHttpServerAsync() : PromiseInterface
- Operation getNetworkWebhooksHttpServerAsync
- getNetworkWebhooksHttpServerAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWebhooksHttpServerAsyncWithHttpInfo
- getNetworkWebhooksHttpServers() : object
- Operation getNetworkWebhooksHttpServers
- getNetworkWebhooksHttpServersAsync() : PromiseInterface
- Operation getNetworkWebhooksHttpServersAsync
- getNetworkWebhooksHttpServersAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWebhooksHttpServersAsyncWithHttpInfo
- getNetworkWebhooksHttpServersWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWebhooksHttpServersWithHttpInfo
- getNetworkWebhooksHttpServerWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWebhooksHttpServerWithHttpInfo
- getNetworkWebhooksWebhookTest() : object
- Operation getNetworkWebhooksWebhookTest
- getNetworkWebhooksWebhookTestAsync() : PromiseInterface
- Operation getNetworkWebhooksWebhookTestAsync
- getNetworkWebhooksWebhookTestAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWebhooksWebhookTestAsyncWithHttpInfo
- getNetworkWebhooksWebhookTestWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWebhooksWebhookTestWithHttpInfo
- getOrganizationWebhooksAlertTypes() : object
- Operation getOrganizationWebhooksAlertTypes
- getOrganizationWebhooksAlertTypesAsync() : PromiseInterface
- Operation getOrganizationWebhooksAlertTypesAsync
- getOrganizationWebhooksAlertTypesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationWebhooksAlertTypesAsyncWithHttpInfo
- getOrganizationWebhooksAlertTypesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationWebhooksAlertTypesWithHttpInfo
- getOrganizationWebhooksLogs() : object
- Operation getOrganizationWebhooksLogs
- getOrganizationWebhooksLogsAsync() : PromiseInterface
- Operation getOrganizationWebhooksLogsAsync
- getOrganizationWebhooksLogsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationWebhooksLogsAsyncWithHttpInfo
- getOrganizationWebhooksLogsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationWebhooksLogsWithHttpInfo
- updateNetworkWebhooksHttpServer() : object
- Operation updateNetworkWebhooksHttpServer
- updateNetworkWebhooksHttpServerAsync() : PromiseInterface
- Operation updateNetworkWebhooksHttpServerAsync
- updateNetworkWebhooksHttpServerAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkWebhooksHttpServerAsyncWithHttpInfo
- updateNetworkWebhooksHttpServerWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkWebhooksHttpServerWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createNetworkWebhooksHttpServerRequest() : Request
- Create request for operation 'createNetworkWebhooksHttpServer'
- createNetworkWebhooksWebhookTestRequest() : Request
- Create request for operation 'createNetworkWebhooksWebhookTest'
- deleteNetworkWebhooksHttpServerRequest() : Request
- Create request for operation 'deleteNetworkWebhooksHttpServer'
- getNetworkWebhooksHttpServerRequest() : Request
- Create request for operation 'getNetworkWebhooksHttpServer'
- getNetworkWebhooksHttpServersRequest() : Request
- Create request for operation 'getNetworkWebhooksHttpServers'
- getNetworkWebhooksWebhookTestRequest() : Request
- Create request for operation 'getNetworkWebhooksWebhookTest'
- getOrganizationWebhooksAlertTypesRequest() : Request
- Create request for operation 'getOrganizationWebhooksAlertTypes'
- getOrganizationWebhooksLogsRequest() : Request
- Create request for operation 'getOrganizationWebhooksLogs'
- updateNetworkWebhooksHttpServerRequest() : Request
- Create request for operation 'updateNetworkWebhooksHttpServer'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —createNetworkWebhooksHttpServer()
Operation createNetworkWebhooksHttpServer
public
createNetworkWebhooksHttpServer(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : object
Add an HTTP server to a network
Parameters
- $network_id : string
-
network_id (required)
- $create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer
-
create_network_webhooks_http_server (required)
Tags
Return values
object —createNetworkWebhooksHttpServerAsync()
Operation createNetworkWebhooksHttpServerAsync
public
createNetworkWebhooksHttpServerAsync(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : PromiseInterface
Add an HTTP server to a network
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer
-
(required)
Tags
Return values
PromiseInterface —createNetworkWebhooksHttpServerAsyncWithHttpInfo()
Operation createNetworkWebhooksHttpServerAsyncWithHttpInfo
public
createNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : PromiseInterface
Add an HTTP server to a network
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer
-
(required)
Tags
Return values
PromiseInterface —createNetworkWebhooksHttpServerWithHttpInfo()
Operation createNetworkWebhooksHttpServerWithHttpInfo
public
createNetworkWebhooksHttpServerWithHttpInfo(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : array<string|int, mixed>
Add an HTTP server to a network
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createNetworkWebhooksWebhookTest()
Operation createNetworkWebhooksWebhookTest
public
createNetworkWebhooksWebhookTest(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : object
Send a test webhook for a network
Parameters
- $network_id : string
-
network_id (required)
- $create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest
-
create_network_webhooks_webhook_test (required)
Tags
Return values
object —createNetworkWebhooksWebhookTestAsync()
Operation createNetworkWebhooksWebhookTestAsync
public
createNetworkWebhooksWebhookTestAsync(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : PromiseInterface
Send a test webhook for a network
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest
-
(required)
Tags
Return values
PromiseInterface —createNetworkWebhooksWebhookTestAsyncWithHttpInfo()
Operation createNetworkWebhooksWebhookTestAsyncWithHttpInfo
public
createNetworkWebhooksWebhookTestAsyncWithHttpInfo(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : PromiseInterface
Send a test webhook for a network
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest
-
(required)
Tags
Return values
PromiseInterface —createNetworkWebhooksWebhookTestWithHttpInfo()
Operation createNetworkWebhooksWebhookTestWithHttpInfo
public
createNetworkWebhooksWebhookTestWithHttpInfo(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : array<string|int, mixed>
Send a test webhook for a network
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteNetworkWebhooksHttpServer()
Operation deleteNetworkWebhooksHttpServer
public
deleteNetworkWebhooksHttpServer(string $network_id, string $http_server_id) : void
Delete an HTTP server from a network
Parameters
- $network_id : string
-
network_id (required)
- $http_server_id : string
-
http_server_id (required)
Tags
Return values
void —deleteNetworkWebhooksHttpServerAsync()
Operation deleteNetworkWebhooksHttpServerAsync
public
deleteNetworkWebhooksHttpServerAsync(string $network_id, string $http_server_id) : PromiseInterface
Delete an HTTP server from a network
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkWebhooksHttpServerAsyncWithHttpInfo()
Operation deleteNetworkWebhooksHttpServerAsyncWithHttpInfo
public
deleteNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, string $http_server_id) : PromiseInterface
Delete an HTTP server from a network
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkWebhooksHttpServerWithHttpInfo()
Operation deleteNetworkWebhooksHttpServerWithHttpInfo
public
deleteNetworkWebhooksHttpServerWithHttpInfo(string $network_id, string $http_server_id) : array<string|int, mixed>
Delete an HTTP server from a network
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkWebhooksHttpServer()
Operation getNetworkWebhooksHttpServer
public
getNetworkWebhooksHttpServer(string $network_id, string $http_server_id) : object
Return an HTTP server for a network
Parameters
- $network_id : string
-
network_id (required)
- $http_server_id : string
-
http_server_id (required)
Tags
Return values
object —getNetworkWebhooksHttpServerAsync()
Operation getNetworkWebhooksHttpServerAsync
public
getNetworkWebhooksHttpServerAsync(string $network_id, string $http_server_id) : PromiseInterface
Return an HTTP server for a network
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkWebhooksHttpServerAsyncWithHttpInfo()
Operation getNetworkWebhooksHttpServerAsyncWithHttpInfo
public
getNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, string $http_server_id) : PromiseInterface
Return an HTTP server for a network
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkWebhooksHttpServers()
Operation getNetworkWebhooksHttpServers
public
getNetworkWebhooksHttpServers(string $network_id) : object
List the HTTP servers for a network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkWebhooksHttpServersAsync()
Operation getNetworkWebhooksHttpServersAsync
public
getNetworkWebhooksHttpServersAsync(string $network_id) : PromiseInterface
List the HTTP servers for a network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkWebhooksHttpServersAsyncWithHttpInfo()
Operation getNetworkWebhooksHttpServersAsyncWithHttpInfo
public
getNetworkWebhooksHttpServersAsyncWithHttpInfo(string $network_id) : PromiseInterface
List the HTTP servers for a network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkWebhooksHttpServersWithHttpInfo()
Operation getNetworkWebhooksHttpServersWithHttpInfo
public
getNetworkWebhooksHttpServersWithHttpInfo(string $network_id) : array<string|int, mixed>
List the HTTP servers for a network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkWebhooksHttpServerWithHttpInfo()
Operation getNetworkWebhooksHttpServerWithHttpInfo
public
getNetworkWebhooksHttpServerWithHttpInfo(string $network_id, string $http_server_id) : array<string|int, mixed>
Return an HTTP server for a network
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkWebhooksWebhookTest()
Operation getNetworkWebhooksWebhookTest
public
getNetworkWebhooksWebhookTest(string $network_id, string $webhook_test_id) : object
Return the status of a webhook test for a network
Parameters
- $network_id : string
-
network_id (required)
- $webhook_test_id : string
-
webhook_test_id (required)
Tags
Return values
object —getNetworkWebhooksWebhookTestAsync()
Operation getNetworkWebhooksWebhookTestAsync
public
getNetworkWebhooksWebhookTestAsync(string $network_id, string $webhook_test_id) : PromiseInterface
Return the status of a webhook test for a network
Parameters
- $network_id : string
-
(required)
- $webhook_test_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkWebhooksWebhookTestAsyncWithHttpInfo()
Operation getNetworkWebhooksWebhookTestAsyncWithHttpInfo
public
getNetworkWebhooksWebhookTestAsyncWithHttpInfo(string $network_id, string $webhook_test_id) : PromiseInterface
Return the status of a webhook test for a network
Parameters
- $network_id : string
-
(required)
- $webhook_test_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkWebhooksWebhookTestWithHttpInfo()
Operation getNetworkWebhooksWebhookTestWithHttpInfo
public
getNetworkWebhooksWebhookTestWithHttpInfo(string $network_id, string $webhook_test_id) : array<string|int, mixed>
Return the status of a webhook test for a network
Parameters
- $network_id : string
-
(required)
- $webhook_test_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationWebhooksAlertTypes()
Operation getOrganizationWebhooksAlertTypes
public
getOrganizationWebhooksAlertTypes(string $organization_id) : object
Return a list of alert types to be used with managing webhook alerts
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationWebhooksAlertTypesAsync()
Operation getOrganizationWebhooksAlertTypesAsync
public
getOrganizationWebhooksAlertTypesAsync(string $organization_id) : PromiseInterface
Return a list of alert types to be used with managing webhook alerts
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationWebhooksAlertTypesAsyncWithHttpInfo()
Operation getOrganizationWebhooksAlertTypesAsyncWithHttpInfo
public
getOrganizationWebhooksAlertTypesAsyncWithHttpInfo(string $organization_id) : PromiseInterface
Return a list of alert types to be used with managing webhook alerts
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationWebhooksAlertTypesWithHttpInfo()
Operation getOrganizationWebhooksAlertTypesWithHttpInfo
public
getOrganizationWebhooksAlertTypesWithHttpInfo(string $organization_id) : array<string|int, mixed>
Return a list of alert types to be used with managing webhook alerts
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationWebhooksLogs()
Operation getOrganizationWebhooksLogs
public
getOrganizationWebhooksLogs(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : object
Return the log of webhook POSTs sent
Parameters
- $organization_id : string
-
organization_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $url : string = null
-
The URL the webhook was sent to (optional)
Tags
Return values
object —getOrganizationWebhooksLogsAsync()
Operation getOrganizationWebhooksLogsAsync
public
getOrganizationWebhooksLogsAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : PromiseInterface
Return the log of webhook POSTs sent
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $url : string = null
-
The URL the webhook was sent to (optional)
Tags
Return values
PromiseInterface —getOrganizationWebhooksLogsAsyncWithHttpInfo()
Operation getOrganizationWebhooksLogsAsyncWithHttpInfo
public
getOrganizationWebhooksLogsAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : PromiseInterface
Return the log of webhook POSTs sent
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $url : string = null
-
The URL the webhook was sent to (optional)
Tags
Return values
PromiseInterface —getOrganizationWebhooksLogsWithHttpInfo()
Operation getOrganizationWebhooksLogsWithHttpInfo
public
getOrganizationWebhooksLogsWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : array<string|int, mixed>
Return the log of webhook POSTs sent
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $url : string = null
-
The URL the webhook was sent to (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkWebhooksHttpServer()
Operation updateNetworkWebhooksHttpServer
public
updateNetworkWebhooksHttpServer(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : object
Update an HTTP server
Parameters
- $network_id : string
-
network_id (required)
- $http_server_id : string
-
http_server_id (required)
- $update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null
-
update_network_webhooks_http_server (optional)
Tags
Return values
object —updateNetworkWebhooksHttpServerAsync()
Operation updateNetworkWebhooksHttpServerAsync
public
updateNetworkWebhooksHttpServerAsync(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : PromiseInterface
Update an HTTP server
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
- $update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkWebhooksHttpServerAsyncWithHttpInfo()
Operation updateNetworkWebhooksHttpServerAsyncWithHttpInfo
public
updateNetworkWebhooksHttpServerAsyncWithHttpInfo(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : PromiseInterface
Update an HTTP server
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
- $update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkWebhooksHttpServerWithHttpInfo()
Operation updateNetworkWebhooksHttpServerWithHttpInfo
public
updateNetworkWebhooksHttpServerWithHttpInfo(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : array<string|int, mixed>
Update an HTTP server
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
- $update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createNetworkWebhooksHttpServerRequest()
Create request for operation 'createNetworkWebhooksHttpServer'
protected
createNetworkWebhooksHttpServerRequest(string $network_id, CreateNetworkWebhooksHttpServer $create_network_webhooks_http_server) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_http_server : CreateNetworkWebhooksHttpServer
-
(required)
Tags
Return values
Request —createNetworkWebhooksWebhookTestRequest()
Create request for operation 'createNetworkWebhooksWebhookTest'
protected
createNetworkWebhooksWebhookTestRequest(string $network_id, CreateNetworkWebhooksWebhookTest $create_network_webhooks_webhook_test) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_webhooks_webhook_test : CreateNetworkWebhooksWebhookTest
-
(required)
Tags
Return values
Request —deleteNetworkWebhooksHttpServerRequest()
Create request for operation 'deleteNetworkWebhooksHttpServer'
protected
deleteNetworkWebhooksHttpServerRequest(string $network_id, string $http_server_id) : Request
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
Request —getNetworkWebhooksHttpServerRequest()
Create request for operation 'getNetworkWebhooksHttpServer'
protected
getNetworkWebhooksHttpServerRequest(string $network_id, string $http_server_id) : Request
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
Tags
Return values
Request —getNetworkWebhooksHttpServersRequest()
Create request for operation 'getNetworkWebhooksHttpServers'
protected
getNetworkWebhooksHttpServersRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getNetworkWebhooksWebhookTestRequest()
Create request for operation 'getNetworkWebhooksWebhookTest'
protected
getNetworkWebhooksWebhookTestRequest(string $network_id, string $webhook_test_id) : Request
Parameters
- $network_id : string
-
(required)
- $webhook_test_id : string
-
(required)
Tags
Return values
Request —getOrganizationWebhooksAlertTypesRequest()
Create request for operation 'getOrganizationWebhooksAlertTypes'
protected
getOrganizationWebhooksAlertTypesRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —getOrganizationWebhooksLogsRequest()
Create request for operation 'getOrganizationWebhooksLogs'
protected
getOrganizationWebhooksLogsRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $url : string = null
-
The URL the webhook was sent to (optional)
Tags
Return values
Request —updateNetworkWebhooksHttpServerRequest()
Create request for operation 'updateNetworkWebhooksHttpServer'
protected
updateNetworkWebhooksHttpServerRequest(string $network_id, string $http_server_id[, UpdateNetworkWebhooksHttpServer $update_network_webhooks_http_server = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $http_server_id : string
-
(required)
- $update_network_webhooks_http_server : UpdateNetworkWebhooksHttpServer = null
-
(optional)