Juniper Mist v0.2.4, Mar 1 25

Juniper Mist v0.2.4 published on Saturday, Mar 1, 2025 by Pulumi

junipermist.site.getWebhooks

Explore with Pulumi AI

Juniper Mist v0.2.4 published on Saturday, Mar 1, 2025 by Pulumi

A Site Webhook is a configuration that allows real-time events and data from a specific site to be pushed to a provided url.
It enables the collection of information about various topics such as device events, alarms, audits, client sessions and location updates at the site level.
The Webhook can be set up and customized using the Mist API, allowing users to receive and analyze specific data from a particular site.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.junipermist.site.SiteFunctions;
import com.pulumi.junipermist.site.inputs.GetWebhooksArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var webhooks = SiteFunctions.getWebhooks(GetWebhooksArgs.builder()
            .orgId("15fca2ac-b1a6-47cc-9953-cc6906281550")
            .build());

    }
}

variables:
  webhooks:
    fn::invoke:
      function: junipermist:site:getWebhooks
      arguments:
        orgId: 15fca2ac-b1a6-47cc-9953-cc6906281550

Using getWebhooks

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWebhooks(args: GetWebhooksArgs, opts?: InvokeOptions): Promise<GetWebhooksResult>
function getWebhooksOutput(args: GetWebhooksOutputArgs, opts?: InvokeOptions): Output<GetWebhooksResult>

def get_webhooks(site_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetWebhooksResult
def get_webhooks_output(site_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetWebhooksResult]

func GetWebhooks(ctx *Context, args *GetWebhooksArgs, opts ...InvokeOption) (*GetWebhooksResult, error)
func GetWebhooksOutput(ctx *Context, args *GetWebhooksOutputArgs, opts ...InvokeOption) GetWebhooksResultOutput

> Note: This function is named GetWebhooks in the Go SDK.

public static class GetWebhooks 
{
    public static Task<GetWebhooksResult> InvokeAsync(GetWebhooksArgs args, InvokeOptions? opts = null)
    public static Output<GetWebhooksResult> Invoke(GetWebhooksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWebhooksResult> getWebhooks(GetWebhooksArgs args, InvokeOptions options)
public static Output<GetWebhooksResult> getWebhooks(GetWebhooksArgs args, InvokeOptions options)

fn::invoke:
  function: junipermist:site/getWebhooks:getWebhooks
  arguments:
    # arguments dictionary

The following arguments are supported:

SiteId string

SiteId string

siteId String

siteId string

site_id str

siteId String

getWebhooks Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
SiteId string
SiteWebhooks List<Pulumi.JuniperMist.Site.Outputs.GetWebhooksSiteWebhook>

Id string: The provider-assigned unique ID for this managed resource.
SiteId string
SiteWebhooks []GetWebhooksSiteWebhook

id String: The provider-assigned unique ID for this managed resource.
siteId String
siteWebhooks List<GetWebhooksSiteWebhook>

id string: The provider-assigned unique ID for this managed resource.
siteId string
siteWebhooks GetWebhooksSiteWebhook[]

id str: The provider-assigned unique ID for this managed resource.
site_id str
site_webhooks Sequence[GetWebhooksSiteWebhook]

id String: The provider-assigned unique ID for this managed resource.
siteId String
siteWebhooks List<Property Map>

Supporting Types

GetWebhooksSiteWebhook

CreatedTime double: When the object has been created, in epoch
Enabled bool: Whether webhook is enabled
Headers Dictionary<string, string>: If type=http-post, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
Id string: Unique ID of the object instance in the Mist Organnization
ModifiedTime double: When the object has been modified for the last time, in epoch
Name string: Name of the webhook
Oauth2ClientId string: Required when oauth2_grant_type==client_credentials
Oauth2ClientSecret string: Required when oauth2_grant_type==client_credentials
Oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
Oauth2Password string: Required when oauth2_grant_type==password
Oauth2Scopes List<string>: Required when type==oauth2, if provided, will be used in the token request
Oauth2TokenUrl string: Required when type==oauth2
Oauth2Username string: Required when oauth2_grant_type==password
OrgId string
Secret string: Only if type=http-post
SiteId string
SplunkToken string: Required if type=splunk. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
Topics List<string>: List of supported webhook topics available with the API Call List Webhook Topics
Type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
Url string
VerifyCert bool: When url uses HTTPS, whether to verify the certificate

CreatedTime float64: When the object has been created, in epoch
Enabled bool: Whether webhook is enabled
Headers map[string]string: If type=http-post, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
Id string: Unique ID of the object instance in the Mist Organnization
ModifiedTime float64: When the object has been modified for the last time, in epoch
Name string: Name of the webhook
Oauth2ClientId string: Required when oauth2_grant_type==client_credentials
Oauth2ClientSecret string: Required when oauth2_grant_type==client_credentials
Oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
Oauth2Password string: Required when oauth2_grant_type==password
Oauth2Scopes []string: Required when type==oauth2, if provided, will be used in the token request
Oauth2TokenUrl string: Required when type==oauth2
Oauth2Username string: Required when oauth2_grant_type==password
OrgId string
Secret string: Only if type=http-post
SiteId string
SplunkToken string: Required if type=splunk. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
Topics []string: List of supported webhook topics available with the API Call List Webhook Topics
Type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
Url string
VerifyCert bool: When url uses HTTPS, whether to verify the certificate

createdTime Double: When the object has been created, in epoch
enabled Boolean: Whether webhook is enabled
headers Map<String,String>: If type=http-post, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
id String: Unique ID of the object instance in the Mist Organnization
modifiedTime Double: When the object has been modified for the last time, in epoch
name String: Name of the webhook
oauth2ClientId String: Required when oauth2_grant_type==client_credentials
oauth2ClientSecret String: Required when oauth2_grant_type==client_credentials
oauth2GrantType String: required when type==oauth2. enum: client_credentials, password
oauth2Password String: Required when oauth2_grant_type==password
oauth2Scopes List<String>: Required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl String: Required when type==oauth2
oauth2Username String: Required when oauth2_grant_type==password
orgId String
secret String: Only if type=http-post
siteId String
splunkToken String: Required if type=splunk. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
topics List<String>: List of supported webhook topics available with the API Call List Webhook Topics
type String: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url String
verifyCert Boolean: When url uses HTTPS, whether to verify the certificate

createdTime number: When the object has been created, in epoch
enabled boolean: Whether webhook is enabled
headers {[key: string]: string}: If type=http-post, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
id string: Unique ID of the object instance in the Mist Organnization
modifiedTime number: When the object has been modified for the last time, in epoch
name string: Name of the webhook
oauth2ClientId string: Required when oauth2_grant_type==client_credentials
oauth2ClientSecret string: Required when oauth2_grant_type==client_credentials
oauth2GrantType string: required when type==oauth2. enum: client_credentials, password
oauth2Password string: Required when oauth2_grant_type==password
oauth2Scopes string[]: Required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl string: Required when type==oauth2
oauth2Username string: Required when oauth2_grant_type==password
orgId string
secret string: Only if type=http-post
siteId string
splunkToken string: Required if type=splunk. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
topics string[]: List of supported webhook topics available with the API Call List Webhook Topics
type string: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url string
verifyCert boolean: When url uses HTTPS, whether to verify the certificate

created_time float: When the object has been created, in epoch
enabled bool: Whether webhook is enabled
headers Mapping[str, str]: If type=http-post, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
id str: Unique ID of the object instance in the Mist Organnization
modified_time float: When the object has been modified for the last time, in epoch
name str: Name of the webhook
oauth2_client_id str: Required when oauth2_grant_type==client_credentials
oauth2_client_secret str: Required when oauth2_grant_type==client_credentials
oauth2_grant_type str: required when type==oauth2. enum: client_credentials, password
oauth2_password str: Required when oauth2_grant_type==password
oauth2_scopes Sequence[str]: Required when type==oauth2, if provided, will be used in the token request
oauth2_token_url str: Required when type==oauth2
oauth2_username str: Required when oauth2_grant_type==password
org_id str
secret str: Only if type=http-post
site_id str
splunk_token str: Required if type=splunk. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
topics Sequence[str]: List of supported webhook topics available with the API Call List Webhook Topics
type str: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url str
verify_cert bool: When url uses HTTPS, whether to verify the certificate

createdTime Number: When the object has been created, in epoch
enabled Boolean: Whether webhook is enabled
headers Map<String>: If type=http-post, additional custom HTTP headers to add. The headers name and value must be string, total bytes of headers name and value must be less than 1000
id String: Unique ID of the object instance in the Mist Organnization
modifiedTime Number: When the object has been modified for the last time, in epoch
name String: Name of the webhook
oauth2ClientId String: Required when oauth2_grant_type==client_credentials
oauth2ClientSecret String: Required when oauth2_grant_type==client_credentials
oauth2GrantType String: required when type==oauth2. enum: client_credentials, password
oauth2Password String: Required when oauth2_grant_type==password
oauth2Scopes List<String>: Required when type==oauth2, if provided, will be used in the token request
oauth2TokenUrl String: Required when type==oauth2
oauth2Username String: Required when oauth2_grant_type==password
orgId String
secret String: Only if type=http-post
siteId String
splunkToken String: Required if type=splunk. If splunk_token is not defined for a type Splunk webhook, it will not send, regardless if the webhook receiver is configured to accept it.
topics List<String>: List of supported webhook topics available with the API Call List Webhook Topics
type String: enum: aws-sns, google-pubsub, http-post, oauth2, splunk
url String
verifyCert Boolean: When url uses HTTPS, whether to verify the certificate

Package Details

Repository: junipermist pulumi/pulumi-junipermist
License: Apache-2.0
Notes: This Pulumi package is based on the mist Terraform Provider.

Juniper Mist v0.2.4 published on Saturday, Mar 1, 2025 by Pulumi

pulumi/pulumi-junipermist

junipermist.site.getWebhooks

On this page

On this page

Example Usage

Using getWebhooks

getWebhooks Result

Supporting Types

GetWebhooksSiteWebhook

Package Details

On this page

On this page