Interface IOrganizationsWebhooksPayloadTemplates

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsWebhooksPayloadTemplates

Methods

CreateOrganizationWebhooksPayloadTemplatesAsync(string, PayloadTemplate, CancellationToken)

List the webhook payload templates for an organization

[Post("/organizations/{organizationId}/webhooks/payloadTemplates")]
Task<PayloadTemplate> CreateOrganizationWebhooksPayloadTemplatesAsync(string organizationId, PayloadTemplate payloadTemplate, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

payloadTemplate PayloadTemplate

The Payload Template

cancellationToken CancellationToken

Returns

Task<PayloadTemplate>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationWebhooksPayloadTemplateAsync(string, string, CancellationToken)

Destroy a webhook payload template for an organization. Does not work for included templates ('wpt_00001', 'wpt_00002', 'wpt_00003', 'wpt_00004', 'wpt_00005' or 'wpt_00006')

[Delete("/organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}")]
Task DeleteOrganizationWebhooksPayloadTemplateAsync(string organizationId, string payloadTemplateId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

payloadTemplateId string

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWebhooksPayloadTemplateAsync(string, string, CancellationToken)

Get the webhook payload template for an organization

[Get("/organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}")]
Task<List<PayloadTemplate>> GetOrganizationWebhooksPayloadTemplateAsync(string organizationId, string payloadTemplateId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

payloadTemplateId string

The payload template id

cancellationToken CancellationToken

Returns

Task<List<PayloadTemplate>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWebhooksPayloadTemplatesAsync(string, CancellationToken)

List the webhook payload templates for an organization

[Get("/organizations/{organizationId}/webhooks/payloadTemplates")]
Task<List<PayloadTemplate>> GetOrganizationWebhooksPayloadTemplatesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<PayloadTemplate>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationWebhooksPayloadTemplateAsync(string, string, PayloadTemplate, CancellationToken)

Update a payload template for an organization

[Put("/organizations/{organizationId}/webhooks/payloadTemplates/{payloadTemplateId}")]
Task<PayloadTemplate> UpdateOrganizationWebhooksPayloadTemplateAsync(string organizationId, string payloadTemplateId, PayloadTemplate webhookPayloadTemplate, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

payloadTemplateId string

The payload template id

webhookPayloadTemplate PayloadTemplate

cancellationToken CancellationToken

Returns

Task<PayloadTemplate>

Exceptions

ApiException

Thrown when fails to make API call