Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 38 Current »

Overview

Check the list of available endpoints and methods to work with delivery methods using the Alerts API:

Endpoints and methods

Description

GET /methods see below

Lists the delivery methods defined in the domain.

GET /methods/{id} see below

Gets a detailed description of a specific delivery method.

POST /methods see below

Creates a new delivery method.

POST /methods/{id}/send-validation-code see below

Sends the code to validate a delivery method.

POST /methods/{id}/validate see below

Validates a delivery method.

PUT /methods/{id} see below

Updates a delivery method.

DELETE /methods/{id} see below

Deletes a specific delivery method.

Endpoints and methods

GET /methods

Retrieves a list of the delivery methods in the domain. The list can be filtered by type using the query parameter.

To perform this request, your Devo user must have at least the Alert configuration (view) permission assigned. Also, note that this request will only retrieve those delivery methods which comply with user’s delivery method specific policies (Jira, Slack…)

Learn more about roles and permissions in this article.

GET /methods/{id}

Gets a detailed description of a specific delivery method given its ID.

To perform this request, your Devo user must have at least the Alert configuration (view) permission assigned and the specific permission (view) for the delivery method type you are retrieving. Learn more about roles and permissions in this article.

POST /methods

Creates a new delivery method in your domain.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned and the specific permission (manage) for the delivery method type you are creating. Learn more about roles and permissions in this article.

POST /methods/{id}/send-validation-code

Sends the code required to validate a delivery method.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned and the specific permission (manage) for the delivery method type you are creating. Learn more about roles and permissions in this article.

POST /methods/{id}/validate

Validate a delivery method that is pending validation.

PUT /methods/{id}

Updates a specific delivery method.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned and the specific permission (manage) for the delivery method type you are creating. Learn more about roles and permissions in this article.

DELETE /methods/{id}

Deletes a specific delivery method given its ID.

To perform this request, your Devo user must have the Alert configuration (manage) permission assigned and the specific permission (manage) for the delivery method type you are deleting. Learn more about roles and permissions in this article.

  • No labels