Create Destination

Create a new destination

  • base_destination_create (DestinationCreateBase): Required. The payload that includes:
    • name (str): Name of the new destination.
    • integration_id (UUID): Unique identifier of the integration to which the destination would be created.
      For Microsoft Teams, Email, or Webhook, omit this and set integration_type to teams, email, or
      webhook on the first destination for that channel so a tenant integration row is created automatically
      (Teams webhook URLs, Email recipient lists, and Webhook URLs/headers live on each destination's params).
    • integration_type (IntegrationType): Optional. Must be teams, email, or webhook when
      integration_id is omitted. When integration_id is set, you may pass slack, teams, email, or
      webhook for a consistent payload shape; it must match the integration's type or be omitted.
    • params (dict): Additional parameters for the creation of the destination.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a destination, a channel where SUPERWISE sends alerts. For Microsoft Teams, email, or a webhook, you can omit integration_id and set integration_type on the first destination for that channel, and SUPERWISE creates the integration for you.

When to use it

Use it to set up where alerts go, then reference the destination in a policy's destination_ids. Check delivery first with Test a destination.

Required parameters

  • name (body): the name of the destination.
  • params (body): the destination settings, such as the Teams webhook URL, the email recipient list, or the webhook URL and headers.

Optional body fields: integration_id, integration_type.

Response

A successful call returns 201 Created with the DestinationResponse object: id, name, integration_id, integration_type, params, and timestamps.

Related: Test a destination, List destinations, Create a policy, List integrations

Body Params
string
required
length between 1 and 300
IntegrationType | null
params
object
required
Responses

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json