README.md

Webhooks

(Webhooks)

Overview

Operations related to Webhooks

Available Operations

• List - List webhooks
• Create - Create a webhook
• Get - Get a webhook
• Delete - Delete a webhook
• Update - Update a webhook
• ListDeliveries - List webhook deliveries

List

Lists webhooks

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Webhooks.List(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.WebhooksEntitiesWebhookEntity != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.ListWebhooksResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Create

Create a new webhook

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/components"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Webhooks.Create(ctx, components.PostV1Webhooks{
        URL: "https://woeful-yin.biz",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.WebhooksEntitiesWebhookEntity != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.CreateWebhookResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Get

Retrieve a specific webhook

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Webhooks.Get(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.WebhooksEntitiesWebhookEntity != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetWebhookResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Delete

Delete a specific webhook

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Webhooks.Delete(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.DeleteWebhookResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Update

Update a specific webhook

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/components"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Webhooks.Update(ctx, "<id>", components.PatchV1WebhooksWebhookID{})
    if err != nil {
        log.Fatal(err)
    }
    if res.WebhooksEntitiesWebhookEntity != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.UpdateWebhookResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

ListDeliveries

List webhook deliveries

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Webhooks.ListDeliveries(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
webhookID	string	✔️	ID of a webhook
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListWebhookDeliveriesResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*