Webhooks

Overview

Available Operations

• GetAll - Get All Webhooks
• Create - Create Webhook
• Update - Update Webhook

GetAll

Returns all the webhooks of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Webhooks.GetAll(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3ExtensionsWebhooksGetAllWebhooksResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
pageLimit	*string	➖	N/A
offset	*string	➖	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.WebhooksGetAllWebhooksResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

Create

Add webhook to the organization. Returns the webhook object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Webhooks.Create(ctx, components.V3ExtensionsWebhooksWebhook{
        Name: "<value>",
        Triggers: []components.V3ExtensionsWebhooksWebhookTrigger{},
        Urls: []components.V3ExtensionsWebhooksWebhookURL{
            components.V3ExtensionsWebhooksWebhookURL{},
        },
        TriggerType: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	components.V3ExtensionsWebhooksWebhook	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.WebhooksCreateWebhookResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*

Update

Update organization webhook details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"github.com/solarwinds/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Webhooks.Update(ctx, "<id>", components.V3ExtensionsWebhooksWebhook{
        Name: "<value>",
        Triggers: []components.V3ExtensionsWebhooksWebhookTrigger{
            components.V3ExtensionsWebhooksWebhookTrigger{
                EventClass: "<value>",
                EventType: "<value>",
            },
        },
        Urls: []components.V3ExtensionsWebhooksWebhookURL{
            components.V3ExtensionsWebhooksWebhookURL{},
        },
        TriggerType: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
eventWebhookID	string	✔️	N/A
v3ExtensionsWebhooksWebhook	components.V3ExtensionsWebhooksWebhook	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.WebhooksUpdateWebhookResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*