subscribers

Creates, updates, deletes, gets or lists a subscribers resource.

Overview

Name	subscribers
Type	Resource
Id	pagerduty.business_services.subscribers

Fields

The following fields are returned by SELECT queries:

get_business_service_subscribers

Name	Datatype	Description
subscriber_id	string	The ID of the entity being subscribed
subscriber_type	string	The type of the entity being subscribed

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_business_service_subscribers	select	id	Accept	Retrieve a list of Notification Subscribers on the Business Service. <!-- theme: warning --> > Users must be added through POST /business_services/&#123;id&#125;/subscribers to be returned from this endpoint. Scoped OAuth requires: subscribers.read
create_business_service_notification_subscribers	insert	id, data__subscribers	Accept	Subscribe the given entities to the given Business Service. Scoped OAuth requires: subscribers.write
_get_business_service_subscribers	exec	id	Accept	Retrieve a list of Notification Subscribers on the Business Service. <!-- theme: warning --> > Users must be added through POST /business_services/&#123;id&#125;/subscribers to be returned from this endpoint. Scoped OAuth requires: subscribers.read

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the resource.
Accept	string	The Accept header is used as a versioning header.

SELECT examples

get_business_service_subscribers

Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->
> Users must be added through POST /business_services/{id}/subscribers to be returned from this endpoint.
Scoped OAuth requires: subscribers.read

SELECT
subscriber_id,
subscriber_type
FROM pagerduty.business_services.subscribers
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
;

INSERT examples

create_business_service_notification_subscribers

Subscribe the given entities to the given Business Service.

Scoped OAuth requires: subscribers.write

INSERT INTO pagerduty.business_services.subscribers (
data__subscribers,
id,
Accept
)
SELECT 
'{{ subscribers }}' /* required */,
'{{ id }}',
'{{ Accept }}'
RETURNING
subscriptions
;

Manifest

# Description fields are for documentation purposes
- name: subscribers
  props:
    - name: id
      value: string
      description: Required parameter for the subscribers resource.
    - name: subscribers
      value: array
    - name: Accept
      value: string
      description: The `Accept` header is used as a versioning header.

Lifecycle Methods

_get_business_service_subscribers

Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->
> Users must be added through POST /business_services/{id}/subscribers to be returned from this endpoint.
Scoped OAuth requires: subscribers.read

EXEC pagerduty.business_services.subscribers._get_business_service_subscribers 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}'
;