Go SDK

Never miss a webhook

Authentication

Get an API key

You'll need to include an API key in every API request. If you do not yet have a Hookdeck account, please sign up for a free account. Your API key is located in your workspace settings.

To include your API key in requests, use either Bearer Token Authentication or Basic Authentication.

Bearer Token Authentication: Include the header Authorization: Bearer $API_KEY, replacing $API_KEY with your personal key Basic Authentication : Set the username as your API key, and supply an empty password

SDK Installation

go get github.com/speakeasy-sdks/hookdeck-go

SDK Example Usage

package main

import(
	"context"
	"log"
	"github.com/speakeasy-sdks/hookdeck-go"
	"github.com/speakeasy-sdks/hookdeck-go/pkg/models/shared"
	"github.com/speakeasy-sdks/hookdeck-go/pkg/models/operations"
)

func main() {
    s := hookdeck.New(
        hookdeck.WithSecurity(shared.Security{
            BasicAuth: &shared.SchemeBasicAuth{
                Password: "",
                Username: "",
            },
        }),
    )
    id := "corrupti"

    ctx := context.Background()
    res, err := s.Attempt.Get(ctx, id)
    if err != nil {
        log.Fatal(err)
    }

    if res.EventAttempt != nil {
        // handle response
    }
}

Available Resources and Operations

Attempt

• Get - Get a Single Attempt

Attempts

• Get - Get Attempts

Bookmark

• Create - Create a Bookmark
• Delete - Delete a Bookmark
• Get - Get a Single Bookmark
• Trigger - Trigger a Bookmark
• Update - Update a Bookmark

Bookmarks

• Get - Get Bookmarks

BulkRetryEvent

• Cancel - Cancel an events bulk retry
• Create - Create an events bulk retry
• Get - Get an events bulk retry

BulkRetryIgnoredEvent

• Cancel - Cancel an ignored events bulk retry
• Create - Create an ignored events bulk retry
• Generate - Generate an ignored events bulk retry plan
• Get - Get an ignored events bulk retry

BulkRetryIgnoredEvents

• Get - Get ignored events bulk retries

BulkRetryRequests

• Create - Create a requests bulk retry

Connection

• Archive - Archive a connection
• Create - Create a connection
• Delete - Delete a connection
• Get - Get a single connection
• Pause - Pause a connection
• Unarchive - Unarchive a connection
• Unpause - Unpause a connection
• Update - Update a connection

ConnectionNumberUpdate

• Upsert - Update or create a connection

Connections

• Get - Get connections

CustomDomain

• Add - Add a custom domain to the workspace
• Delete - Removes a custom domain from the workspace

CustomDomains

• List - List all custom domains and their verification statuses for the workspace

Destination

• Archive - Archive a Destination
• Create - Create a Destination
• Delete - Delete a Destination
• Get - Get a Destination
• Unarchive - Unarchive a Destination
• Update - Update a Destination
• Upsert - Update or Create a Destination

Destinations

• Get - Get Destinations

Event

• Get - Get an Event
• MuteEvent - Mute an Event
• Retry - Retry an Event

EventRawBody

• Get - Get an Event Raw Body Data

Events

• Get - Get Events

Integration

• AttachIntegrationToSource - Attach an integration to a source
• Create - Create an integration
• Delete - Delete an integration
• DetachIntegrationToSource - Detach an integration from a source
• Get - Get an integration
• Update - Update an integration

Integrations

• Get - Get integrations

Issue

• Dismiss - Dismiss an issue
• Get - Get a single issue
• Update - Update issue

IssueTrigger

• Create - Create an Issue Trigger
• Delete - Delete an Issue Trigger
• Disable - Disable an Issue Trigger
• Enable - Enable an Issue Trigger
• Get - Get an Issue Trigger
• Update - Update an Issue Trigger
• Upsert - Create or Update an Issue Trigger

IssueTriggers

• Get - Get Issue Triggers

Issues

• Get - Get issues

IssuesCount

• Get - Get the number of issues

Request

• Get - Get a request
• Retry - Retry a request

RequestBulkRetry

• Cancel - Cancel a requests bulk retry
• Get - Get a requests bulk retry

RequestEvents

• Get - Get request events

RequestIgnoredEvents

• Get - Get request ignored events

RequestRawBody

• Get - Get a request raw body data

Requests

• Get - Get requests

Ruleset

• Archive - Archive a ruleset
• Create - Create a ruleset
• Get - Get a ruleset
• Unarchive - Unarchive a ruleset
• Update - Update a ruleset
• Upsert - Update or create a ruleset

Rulesets

• Get - Get rulesets

Source

• Archive - Archive a source
• Create - Create a source
• Delete - Delete a source
• Get - Get a source
• Unarchive - Unarchive a source
• Update - Update a source
• Upsert - Update or create a source

Sources

• Get - Get sources

Transformation

• Create - Create a transformation
• Get - Get a transformation
• Test - Test a transformation code
• Update - Update a transformation
• Upsert - Update or create a transformation

TransformationExecution

• Get - Get a transformation execution

TransformationExecutions

• Get - Get transformation executions

Transformations

• Get - Get transformations

WebhookNotifications

• Toggle - Toggle webhook notifications for the workspace

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy