webhook_subscriptions

Overview

Name	webhook_subscriptions
Type	Resource
Id	pagerduty.webhooks.webhook_subscriptions

Fields

Name	Datatype	Description
id	string
description	string	A short description of the webhook subscription.
active	boolean	Determines whether this subscription will produce webhook events.
delivery_method	object
events	array	The set of outbound event types the webhook will receive.
filter	object
type	string	The type indicating the schema of the object.

Methods

Name	Accessible by	Required Params	Description
get_webhook_subscription	SELECT	id	Gets details about an existing webhook subscription.
list_webhook_subscriptions	SELECT		List existing webhook subscriptions. The filter_type and filter_id query parameters may be used to only show subscriptions for a particular service or team. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the Webhooks v3 Developer Documentation.
create_webhook_subscription	INSERT	data__webhook_subscription	Creates a new webhook subscription. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the Webhooks v3 Developer Documentation.
delete_webhook_subscription	DELETE	id	Deletes a webhook subscription.
_get_webhook_subscription	EXEC	id	Gets details about an existing webhook subscription.
_list_webhook_subscriptions	EXEC		List existing webhook subscriptions. The filter_type and filter_id query parameters may be used to only show subscriptions for a particular service or team. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the Webhooks v3 Developer Documentation.
enable_webhook_subscription	EXEC	id	Enable a webhook subscription that is temporarily disabled. (This API does not require a request body.) Webhook subscriptions can become temporarily disabled when the subscription's delivery method is repeatedly rejected by the server.
test_webhook_subscription	EXEC	id	Test a webhook subscription. Fires a test event against the webhook subscription. If properly configured, this will deliver the pagey.ping webhook event to the destination.
update_webhook_subscription	EXEC	id	Updates an existing webhook subscription. Only the fields being updated need to be included on the request. This operation does not support updating the delivery_method of the webhook subscription.