Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

convoy_go

package module

Go to main page

Versions in this module

v2

v2.1.7

May 9, 2024

v2.1.6

Apr 26, 2024

Changes in this version

type Client

+ PortalLinks *PortalLink

v2.1.5

Apr 5, 2024

v2.1.4

Feb 8, 2024

v2.1.3

Jan 31, 2024

Changes in this version

+ var DefaultSigHeader = "X-Convoy-Signature"

type Webhook

+ func (w *Webhook) VerifyPayload(b []byte, header string) error

+ func (w *Webhook) VerifyRequest(r *http.Request) error

+ type WebhookOpts struct

+ Encoding EncodingType

+ Hash string

+ Secret string

+ SigHeader string

+ Tolerance time.Duration

v2.1.2

Nov 30, 2023

v2.1.1

Nov 29, 2023

v2.0.1

Nov 8, 2023

v2.0.0

Nov 8, 2023

Changes in this version

+ const DEFAULT_BASE_URL

+ var DefaultEncoding EncodingType = HexEncoding

+ var DefaultHash = "SHA256"

+ var DefaultTolerance = 300 * time.Second

+ var ErrInvalidEncoding = errors.New("invalid encoding")

+ var ErrInvalidHashAlgorithm = errors.New("invalid hash algorithm")

+ var ErrInvalidHeader = errors.New("webhook has invalid header")

+ var ErrInvalidSignature = errors.New("webhook has no valid signature")

+ var ErrInvalidSignatureHeader = errors.New("webhook has no signature header")

+ var ErrNotDeliveryAttemptResponse = errors.New("invalid delivery attempt response")

+ var ErrNotEndpointResponse = errors.New("invalid endpoint response")

+ var ErrNotEventDeliveryResponse = errors.New("invalid event delivery response")

+ var ErrNotEventResponse = errors.New("invalid event response")

+ var ErrNotListDeliveryAttemptResponse = errors.New("invalid list delivery attempt response")

+ var ErrNotListEndpointResponse = errors.New("invalid list endpoint response")

+ var ErrNotListEventDeliveryResponse = errors.New("invalid list event delivery response")

+ var ErrNotListEventResponse = errors.New("invalid list event response")

+ var ErrNotListProjectResponse = errors.New("invalid list project response")

+ var ErrNotListSourceResponse = errors.New("invalid list source response")

+ var ErrNotListSubscriptionResponse = errors.New("invalid list subscription response")

+ var ErrNotProjectResponse = errors.New("invalid project response")

+ var ErrNotSourceResponse = errors.New("invalid source response")

+ var ErrNotSubscriptionResponse = errors.New("invalid subscription response")

+ var ErrTimestampExpired = errors.New("timestamp has expired")

+ func NewLogger(out io.Writer, lvl Level) *log.Logger

+ func OptionHTTPClient(client *http.Client) func(c *Client)

+ func OptionKafkaOptions(ko *KafkaOptions) func(c *Client)

+ func OptionLogger(logger iLogger) func(c *Client)

+ func OptionSQSOptions(so *SQSOptions) func(c *Client)

+ type APIResponse struct

+ Data *json.RawMessage

+ Message string

+ Status bool

+ type AlertConfiguration struct

+ Count int

+ Threshold string

+ type ApiKey struct

+ HeaderName string

+ HeaderValue string

+ type ApiKeyAuth struct

+ HeaderName string

+ HeaderValue string

+ type BasicAuth struct

+ Password string

+ UserName string

+ type BatchReplayOptions struct

+ EndDate time.Time

+ SourceID string

+ StartDate time.Time

+ type Client struct

+ DeliveryAttempts *DeliveryAttempt

+ Endpoints *Endpoint

+ EventDeliveries *EventDelivery

+ Events *Event

+ Kafka *Kafka

+ Projects *Project

+ SQS *SQS

+ Sources *Source

+ Subscriptions *Subscription

+ func New(baseURL, apiKey, projectID string, options ...Option) *Client

+ type ConfigOpts struct

+ Encoding EncodingType

+ Hash string

+ IsAdvanced bool

+ Payload []byte

+ Secret string

+ SigHeader string

+ Tolerance time.Duration

+ type CreateDynamicEventRequest struct

+ Endpoint string

+ Event string

+ Subscription string

+ type CreateEndpointRequest struct

+ AdvancedSignatures *bool

+ Authentication *EndpointAuth

+ Description string

+ HttpTimeout string

+ IsDisabled bool

+ Name string

+ OwnerID string

+ RateLimit int

+ RateLimitDuration string

+ Secret string

+ SlackWebhookUrl string

+ SupportEmail string

+ URL string

+ type CreateEventRequest struct

+ CustomHeaders map[string]string

+ Data json.RawMessage

+ EndpointID string

+ EventType string

+ IdempotencyKey string

+ type CreateFanoutEventRequest struct

+ CustomHeaders map[string]string

+ Data json.RawMessage

+ EventType string

+ IdempotencyKey string

+ OwnerID string

+ type CreatePortalLinkRequest struct

+ CanManageEndpoint bool

+ Endpoints []string

+ Name string

+ OwnerID string

+ type CreateProjectRequest struct

+ LogoUrl string

+ Name string

+ Project *ProjectConfig

+ RateLimit int

+ RateLimitDuration string

+ Type string

+ type CreateSourceRequest struct

+ IsDisabled bool

+ Name string

+ Provider string

+ Type string

+ Verifier VerifierConfig

+ type CreateSubscriptionRequest struct

+ AlertConfig *AlertConfiguration

+ EndpointID string

+ FilterConfig *FilterConfiguration

+ Name string

+ RetryConfig *RetryConfiguration

+ SourceID string

+ type DeliveryAttempt struct

+ func (d *DeliveryAttempt) All(ctx context.Context, eventDeliveryID string, query *DeliveryAttemptQueryParam) (*ListDeliveryAttemptResponse, error)

+ func (d *DeliveryAttempt) Find(ctx context.Context, eventDeliveryID, deliveryAttemptID string, ...) (*DeliveryAttemptResponse, error)

+ type DeliveryAttemptQueryParam struct

+ GroupID string

+ type DeliveryAttemptResponse struct

+ APIVersion string

+ CreatedAt time.Time

+ DeletedAt time.Time

+ EndpointID string

+ Error string

+ HttpResponseCode string

+ IPAddress string

+ Method string

+ MsgID string

+ RequestHeader map[string]string

+ ResponseData string

+ ResponseHeader map[string]string

+ Status bool

+ UID string

+ URL string

+ UpdatedAt time.Time

+ type EncodingType string

+ const Base64Encoding

+ const HexEncoding

+ type Endpoint struct

+ func (e *Endpoint) All(ctx context.Context, query *EndpointParams) (*ListEndpointResponse, error)

+ func (e *Endpoint) Create(ctx context.Context, body *CreateEndpointRequest, query *EndpointParams) (*EndpointResponse, error)

+ func (e *Endpoint) Delete(ctx context.Context, endpointID string, query *EndpointParams) error

+ func (e *Endpoint) Find(ctx context.Context, endpointID string, query *EndpointParams) (*EndpointResponse, error)

+ func (e *Endpoint) Pause(ctx context.Context, Id string) (*EndpointResponse, error)

+ func (e *Endpoint) Update(ctx context.Context, endpointID string, body *CreateEndpointRequest, ...) (*EndpointResponse, error)

+ func (e Endpoint) RollSecret(ctx context.Context, Id string, body *RollSecretRequest) error

+ type EndpointAuth struct

+ ApiKey *ApiKeyAuth

+ Type string

+ type EndpointParams struct

+ OwnerID string

+ Query string

+ type EndpointResponse struct

+ AdvancedSignatures bool

+ Authentication *EndpointAuth

+ CreatedAt time.Time

+ Description string

+ Events int64

+ GroupID string

+ HttpTimeout string

+ IsDisabled bool

+ OwnerID string

+ RateLimit int

+ RateLimitDuration string

+ Secrets []Secret

+ SlackWebhookUrl string

+ Status string

+ SupportEmail string

+ TargetUrl string

+ Title string

+ UID string

+ UpdatedAt time.Time

+ type Event struct

+ func (e *Event) All(ctx context.Context, query *EventParams) (*ListEventResponse, error)

+ func (e *Event) BatchReplay(ctx context.Context, query *BatchReplayOptions) error

+ func (e *Event) Create(ctx context.Context, body *CreateEventRequest) (*EventResponse, error)

+ func (e *Event) FanoutEvent(ctx context.Context, body *CreateFanoutEventRequest) (*EventResponse, error)

+ func (e *Event) Find(ctx context.Context, eventID string) (*EventResponse, error)

+ func (e *Event) Replay(ctx context.Context, eventID string) error

+ type EventDelivery struct

+ func (e *EventDelivery) All(ctx context.Context, query *EventDeliveryParams) (*ListEventDeliveryResponse, error)

+ func (e *EventDelivery) BatchResend(ctx context.Context, query *EventDeliveryParams) error

+ func (e *EventDelivery) Find(ctx context.Context, eventDeliveryID string, query *EventDeliveryParams) (*EventDeliveryResponse, error)

+ func (e *EventDelivery) Resend(ctx context.Context, eventDeliveryID string, query *EventDeliveryParams) (*EventDeliveryResponse, error)

+ type EventDeliveryParams struct

+ EndDate time.Time

+ EndpointID []string

+ EventID string

+ StartDate time.Time

+ Status []string

+ SubscriptionID string

+ type EventDeliveryResponse struct

+ CreatedAt time.Time

+ Description string

+ EndpointMetadata EndpointResponse

+ EventMetadata EventMetadata

+ Metadata Metadata

+ Status string

+ UID string

+ UpdatedAt time.Time

+ type EventMetadata struct

+ Name string

+ UID string

+ type EventParams struct

+ EndDate time.Time

+ EndpointID []string

+ Query string

+ SourceID string

+ StartDate time.Time

+ type EventResponse struct

+ CreatedAt time.Time

+ Data json.RawMessage

+ EndpointMetadata []*EndpointResponse

+ EventType string

+ MatchedEndpoints int

+ ProviderID string

+ UID string

+ UpdatedAt time.Time

+ type FilterConfiguration struct

+ EventTypes []string

+ type HMac struct

+ Encoding string

+ Hash string

+ Header string

+ Secret string

+ type Kafka struct

+ func (k *Kafka) WriteEvent(ctx context.Context, body *CreateEventRequest) error

+ func (k *Kafka) WriteFanoutEvent(ctx context.Context, body *CreateFanoutEventRequest) error

+ type KafkaOptions struct

+ Client *kafka.Client

+ Topic string

+ type Level int32

+ const DebugLevel

+ const ErrorLevel

+ const FatalLevel

+ const InfoLevel

+ const WarnLevel

+ type ListDeliveryAttemptResponse []DeliveryAttemptResponse

+ type ListEndpointResponse struct

+ Content []EndpointResponse

+ Pagination Pagination

+ type ListEventDeliveryResponse struct

+ Content []EventDeliveryResponse

+ Pagination Pagination

+ type ListEventResponse struct

+ Content []EventResponse

+ Pagination Pagination

+ type ListParams struct

+ NextPageCursor string

+ PerPage int

+ PrevPageCursor string

+ type ListPortalLinkResponse struct

+ Content []PortalLinkResponse

+ Pagination Pagination

+ type ListProjectResponse []ProjectResponse

+ type ListSourceResponse struct

+ Content []SourceResponse

+ Pagination Pagination

+ type ListSubscriptionResponse struct

+ Content []SubscriptionResponse

+ Pagination Pagination

+ type Metadata struct

+ Data json.RawMessage

+ IntervalSeconds uint64

+ NextSendTime time.Time

+ NumTrials uint64

+ RetryLimit uint64

+ Strategy string

+ type Option func(*Client)

+ type Pagination struct

+ HasNextPage bool

+ HasPrevPage bool

+ NextPageCursor string

+ PerPage int

+ PrevPageCursor string

+ type PortalLink struct

+ func (p *PortalLink) All(ctx context.Context) (*ListPortalLinkResponse, error)

+ func (p *PortalLink) Create(ctx context.Context, body *CreatePortalLinkRequest) (*PortalLinkResponse, error)

+ func (p *PortalLink) Find(ctx context.Context, portalLinkID string) (*PortalLinkResponse, error)

+ func (p *PortalLink) Revoke(ctx context.Context, portalLinkID string) error

+ func (p *PortalLink) Update(ctx context.Context, portalLinkID string, body *UpdatePortalLinkRequest) (*PortalLinkResponse, error)

+ type PortalLinkResponse struct

+ CanManageEndpoint bool

+ CreatedAt time.Time

+ DeletedAt time.Time

+ EndpointCount int

+ Endpoints []string

+ EndpointsMetadata []EndpointResponse

+ Name string

+ OwnerID string

+ ProjectID string

+ Token string

+ UID string

+ URL string

+ UpdatedAt time.Time

+ type Project struct

+ func (p *Project) Delete(ctx context.Context, projectID string) error

+ func (p *Project) Find(ctx context.Context, projectID string) (*ProjectResponse, error)

+ func (p *Project) Update(ctx context.Context, projectID string, body *CreateProjectRequest) (*ProjectResponse, error)

+ type ProjectConfig struct

+ DisableEndpoint bool

+ IsRetentionPolicyEnabled bool

+ RateLimit *RateLimitConfiguration

+ ReplayAttacks bool

+ RetentionPolicy *RetentionPolicyConfiguration

+ Signature *SignatureConfiguration

+ Strategy *StrategyConfiguration

+ type ProjectMetadata struct

+ RetainedEvents int

+ type ProjectResponse struct

+ Config *ProjectConfig

+ CreatedAt time.Time

+ LogoUrl string

+ Metadata *ProjectMetadata

+ Name string

+ OrganisationID string

+ RateLimit int

+ RateLimitDuration string

+ Statistics struct{ ... }

+ Type string

+ UID string

+ UpdatedAt time.Time

+ type ProviderConfig struct

+ Twitter *TwitterProviderConfig

+ type RateLimitConfiguration struct

+ Count int

+ Duration uint64

+ type RetentionPolicyConfiguration struct

+ Policy string

+ type RetryConfiguration struct

+ Duration string

+ RetryCount int

+ Type string

+ type RollSecretRequest struct

+ Expiration int

+ Secret string

+ type SQS struct

+ func (s *SQS) WriteEvent(ctx context.Context, body *CreateEventRequest) error

+ func (s *SQS) WriteFanoutEvent(ctx context.Context, body *CreateFanoutEventRequest) error

+ type SQSOptions struct

+ Client *sqs.Client

+ QueueUrl string

+ type Secret struct

+ ExpiresAt time.Time

+ UID string

+ Value string

+ type SignatureConfiguration struct

+ Hash string

+ Header string

+ type Source struct

+ func (s *Source) All(ctx context.Context, query *SourceParams) (*ListSourceResponse, error)

+ func (s *Source) Create(ctx context.Context, body *CreateSourceRequest) (*SourceResponse, error)

+ func (s *Source) Delete(ctx context.Context, sourceId string) error

+ func (s *Source) Find(ctx context.Context, sourceId string) (*SourceResponse, error)

+ func (s *Source) Update(ctx context.Context, sourceId string, body *CreateSourceRequest) (*SourceResponse, error)

+ type SourceParams struct

+ Type string

+ type SourceResponse struct

+ CreatedAt time.Time

+ ForwardHeaders []string

+ GroupID string

+ IsDisabled bool

+ MaskID string

+ Name string

+ Provider string

+ ProviderConfig *ProviderConfig

+ Type string

+ UID string

+ UpdatedAt time.Time

+ Verifier *VerifierConfig

+ type StrategyConfiguration struct

+ Duration uint64

+ RetryCount uint64

+ Type string

+ type Subscription struct

+ func (s *Subscription) All(ctx context.Context, query *SubscriptionParams) (*ListSubscriptionResponse, error)

+ func (s *Subscription) Create(ctx context.Context, body *CreateSubscriptionRequest) (*SubscriptionResponse, error)

+ func (s *Subscription) Delete(ctx context.Context, subscriptionId string) error

+ func (s *Subscription) Find(ctx context.Context, subscriptionId string) (*SubscriptionResponse, error)

+ func (s *Subscription) Update(ctx context.Context, subscriptionId string, body *CreateSubscriptionRequest) (*SubscriptionResponse, error)

+ type SubscriptionParams struct

+ EndpointID []string

+ type SubscriptionResponse struct

+ AlertConfig *AlertConfiguration

+ CreatedAt time.Time

+ Endpoint *EndpointResponse

+ FilterConfig *FilterConfiguration

+ Name string

+ RetryConfig *RetryConfiguration

+ Source *SourceResponse

+ Status string

+ Type string

+ UID string

+ UpdatedAt time.Time

+ type TwitterProviderConfig struct

+ CrcVerifiedAt time.Time

+ type UpdatePortalLinkRequest struct

+ CanManageEndpoint bool

+ Endpoints []string

+ Name string

+ OwnerID string

+ type VerifierConfig struct

+ ApiKey *ApiKey

+ BasicAuth *BasicAuth

+ HMac *HMac

+ Type string

+ type Webhook struct

+ Encoding EncodingType

+ Hash string

+ IsAdvanced bool

+ Payload []byte

+ Secret string

+ SigHeader string

+ Tolerance time.Duration

+ func NewWebhook(data *ConfigOpts) *Webhook

+ func (w *Webhook) Verify() error

Other modules containing this package

github.com/frain-dev/convoy-go