Interface INetworksWebhooksPayloadTemplates

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface INetworksWebhooksPayloadTemplates

Methods

CreateNetworkWebhooksPayloadTemplateAsync(string, PayloadTemplate, CancellationToken)

Create a webhook payload template for a network

[Post("/networks/{networkId}/webhooks/payloadTemplates")]
Task<PayloadTemplate> CreateNetworkWebhooksPayloadTemplateAsync(string networkId, PayloadTemplate webhookPayloadTemplate, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

webhookPayloadTemplate PayloadTemplate

Payload Template

cancellationToken CancellationToken

Returns

Task<PayloadTemplate>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkWebhooksPayloadTemplateAsync(string, string, CancellationToken)

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

[Delete("/networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}")]
Task DeleteNetworkWebhooksPayloadTemplateAsync(string networkId, string payloadTemplateId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

payloadTemplateId string

The payload template id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkWebhooksPayloadTemplateAsync(string, string, CancellationToken)

Return a single network webhook payload template

[Get("/networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}")]
Task<PayloadTemplate> GetNetworkWebhooksPayloadTemplateAsync(string networkId, string payloadTemplateId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

payloadTemplateId string

The payload template id

cancellationToken CancellationToken

Returns

Task<PayloadTemplate>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkWebhooksPayloadTemplatesAsync(string, CancellationToken)

Return the list of network webhook payload templates

[Get("/networks/{networkId}/webhooks/payloadTemplates")]
Task<List<PayloadTemplate>> GetNetworkWebhooksPayloadTemplatesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<PayloadTemplate>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkWebhooksPayloadTemplateAsync(string, string, PayloadTemplate, CancellationToken)

Update a webhook payload template for a network

[Put("/networks/{networkId}/webhooks/payloadTemplates/{payloadTemplateId}")]
Task<PayloadTemplate> UpdateNetworkWebhooksPayloadTemplateAsync(string networkId, string payloadTemplateId, PayloadTemplate webhookPayloadTemplate, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

payloadTemplateId string

The payload template id

webhookPayloadTemplate PayloadTemplate

cancellationToken CancellationToken

Returns

Task<PayloadTemplate>

Exceptions

ApiException

Thrown when fails to make API call