> For the complete documentation index, see [llms.txt](https://developers.incidents.cloud.solarwinds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/sdks/webhooks.md).

# Webhooks

## Overview

### Available Operations

* [GetAll](#getall) - Get All Webhooks
* [Create](#create) - Create Webhook
* [Update](#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

```go
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](https://pkg.go.dev/context#Context)                                                             | :heavy\_check\_mark: | The context to use for the request. |
| `pageLimit` | `*string`                                                                                                         | :heavy\_minus\_sign: | N/A                                 |
| `offset`    | `*string`                                                                                                         | :heavy\_minus\_sign: | N/A                                 |
| `opts`      | \[][operations.Option](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/option.md) | :heavy\_minus\_sign: | The options for this request.       |

### Response

[**\*operations.WebhooksGetAllWebhooksResponse**](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/webhooksgetallwebhooksresponse.md)**, 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

```go
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](https://pkg.go.dev/context#Context)                                                                                                    | :heavy\_check\_mark: | The context to use for the request.        |
| `request` | [components.V3ExtensionsWebhooksWebhook](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/components/v3extensionswebhookswebhook.md) | :heavy\_check\_mark: | The request object to use for the request. |
| `opts`    | \[][operations.Option](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/option.md)                                        | :heavy\_minus\_sign: | The options for this request.              |

### Response

[**\*operations.WebhooksCreateWebhookResponse**](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/webhookscreatewebhookresponse.md)**, 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

```go
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](https://pkg.go.dev/context#Context)                                                                                                    | :heavy\_check\_mark: | The context to use for the request. |
| `eventWebhookID`              | `string`                                                                                                                                                 | :heavy\_check\_mark: | N/A                                 |
| `v3ExtensionsWebhooksWebhook` | [components.V3ExtensionsWebhooksWebhook](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/components/v3extensionswebhookswebhook.md) | :heavy\_check\_mark: | N/A                                 |
| `opts`                        | \[][operations.Option](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/option.md)                                        | :heavy\_minus\_sign: | The options for this request.       |

### Response

[**\*operations.WebhooksUpdateWebhookResponse**](https://developers.incidents.cloud.solarwinds.com/go-sdk/docs/models/operations/webhooksupdatewebhookresponse.md)**, 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    | \*/\*            |
