convoy_go

package module

Go to main page

Versions in this module

v1

v1.0.2

Apr 7, 2023

Changes in this version

+ type CreateFanoutEventRequest struct

+ CustomHeaders map[string]string

+ Data json.RawMessage

+ EventType string

+ OwnerID string

type EndpointQueryParam

+ OwnerID string

type Event

+ func (e *Event) CreateFanoutEvent(opts *CreateFanoutEventRequest) (*EventResponse, error)

v1.0.1

Mar 16, 2023

Changes in this version

type CreateEventRequest

+ CustomHeaders map[string]string

v1.0.0

Dec 6, 2022

Changes in this version

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

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

+ type ApiKeyAuth struct

+ HeaderName string

+ HeaderValue string

type Convoy

+ Projects *Project

type CreateEndpointRequest

+ AdvancedSignatures *bool

+ Authentication *EndpointAuth

+ IsDisabled bool

+ Name string

+ OwnerID string

+ SlackWebhookUrl string

+ SupportEmail string

type CreateEventRequest

+ EndpointID string

+ type CreateProjectRequest struct

+ LogoUrl string

+ Name string

+ Project *ProjectConfig

+ RateLimit int

+ RateLimitDuration string

+ Type string

+ type EndpointAuth struct

+ ApiKey *ApiKeyAuth

+ Type string

type EndpointResponse

+ AdvancedSignatures bool

+ Authentication *EndpointAuth

+ GroupID string

+ IsDisabled bool

+ OwnerID string

+ Secrets []Secret

+ SlackWebhookUrl string

+ SupportEmail string

+ Title string

type EventDeliveryQueryParam

+ EndpointID string

type EventQueryParam

+ EndpointID string

type EventResponse

+ EndpointMetadata []*EndpointResponse

type ListEndpointResponse

+ Content []EndpointResponse

+ Pagination Pagination

+ type ListProjectResponse []ProjectResponse

type Options

+ ProjectID string

+ type Project struct

+ func (g *Project) Delete(id string) error

+ func (g *Project) Find(id string) (*ProjectResponse, error)

+ func (g *Project) Update(id string, opts *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 Secret struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ ExpiresAt time.Time

+ UID string

+ UpdatedAt time.Time

+ Value string

type SubscriptionQueryParam

+ EndpointID string

v0

v0.3.5

Dec 6, 2022

Changes in this version

type SubscriptionQueryParam

+ AppID string

v0.3.4

Nov 25, 2022

v0.3.3

Oct 29, 2022

v0.3.2

Oct 24, 2022

Changes in this version

+ 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 ErrTimestampExpired = errors.New("timestamp has expired")

+ type ConfigOpts struct

+ Encoding EncodingType

+ Hash string

+ IsAdvanced bool

+ Payload []byte

+ Secret string

+ SigHeader string

+ Tolerance time.Duration

+ type EncodingType string

+ const Base64Encoding

+ const HexEncoding

+ 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

v0.3.1

Sep 22, 2022

Changes in this version

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

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

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

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

+ type AlertConfiguration struct

+ Count int

+ Threshold string

+ type ApiKey struct

+ HeaderName string

+ HeaderValue string

+ type BasicAuth struct

+ Password string

+ UserName string

type Convoy

+ Sources *Source

+ Subscriptions *Subscription

type CreateGroupRequest

+ Type string

+ type CreateSourceRequest struct

+ IsDisabled bool

+ Name string

+ Provider string

+ Type string

+ Verifier VerifierConfig

+ type CreateSubscriptionRequest struct

+ AlertConfig *AlertConfiguration

+ AppID string

+ EndpointID string

+ FilterConfig *FilterConfiguration

+ Name string

+ RetryConfig *RetryConfiguration

+ SourceID string

+ type FilterConfiguration struct

+ EventTypes []string

type GroupConfig

+ IsRetentionPolicyEnabled bool

+ RateLimit *RateLimitConfiguration

+ RetentionPolicy *RetentionPolicyConfiguration

+ type GroupMetadata struct

+ RetainedEvents int

type GroupResponse

+ Config *GroupConfig

+ Metadata *GroupMetadata

+ OrganisationID string

+ Type string

+ type HMac struct

+ Encoding string

+ Hash string

+ Header string

+ Secret string

+ type ListSourceResponse struct

+ Content []SourceResponse

+ Pagination Pagination

+ type ListSubscriptionResponse struct

+ Content []SubscriptionResponse

+ Pagination Pagination

+ 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 Source struct

+ func (s *Source) All(query *SourceQueryParam) (*ListSourceResponse, error)

+ func (s *Source) Create(opts *CreateSourceRequest) (*SourceResponse, error)

+ func (s *Source) Delete(id string) error

+ func (s *Source) Find(id string) (*SourceResponse, error)

+ func (s *Source) Update(id string, opts *CreateSourceRequest) (*SourceResponse, error)

+ type SourceQueryParam struct

+ GroupID string

+ Page int

+ PerPage int

+ 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

+ Duration uint64

+ RetryCount uint64

+ type Subscription struct

+ func (s *Subscription) All(query *SubscriptionQueryParam) (*ListSubscriptionResponse, error)

+ func (s *Subscription) Create(opts *CreateSubscriptionRequest) (*SubscriptionResponse, error)

+ func (s *Subscription) Delete(id string) error

+ func (s *Subscription) Find(id string) (*SubscriptionResponse, error)

+ func (s *Subscription) Update(id string, opts *CreateSubscriptionRequest) (*SubscriptionResponse, error)

+ type SubscriptionQueryParam struct

+ GroupID string

+ Page int

+ PerPage int

+ type SubscriptionResponse struct

+ AlertConfig *AlertConfiguration

+ App *Application

+ CreatedAt time.Time

+ Endpoint *Endpoint

+ FilterConfig *FilterConfiguration

+ Name string

+ RetryConfig *RetryConfiguration

+ Source *Source

+ Status string

+ Type string

+ UID string

+ UpdatedAt time.Time

+ type TwitterProviderConfig struct

+ CrcVerifiedAt time.Time

+ type VerifierConfig struct

+ ApiKey *ApiKey

+ BasicAuth *BasicAuth

+ HMac *HMac

+ Type string

v0.3.0

Apr 13, 2022

Changes in this version

+ var ErrNotApplicationResponse = errors.New("invalid application response")

+ 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 ErrNotGroupResponse = errors.New("invalid group response")

+ var ErrNotListApplicationResponse = errors.New("invalid list application 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 ErrNotListGroupResponse = errors.New("invalid list group response")

+ type APIResponse struct

+ Data *json.RawMessage

+ Message string

+ Status bool

+ type AppMetadata struct

+ GroupID string

+ SupportEmail string

+ Title string

+ UID string

+ type Application struct

+ func (a *Application) All(query *ApplicationQueryParam) (*ListApplicationResponse, error)

+ func (a *Application) Create(opts *CreateApplicationRequest, query *ApplicationQueryParam) (*ApplicationResponse, error)

+ func (a *Application) Delete(id string, query *ApplicationQueryParam) error

+ func (a *Application) Find(id string, query *ApplicationQueryParam) (*ApplicationResponse, error)

+ func (a *Application) Update(id string, opts *CreateApplicationRequest, query *ApplicationQueryParam) (*ApplicationResponse, error)

+ type ApplicationQueryParam struct

+ GroupID string

+ Page int

+ PerPage int

+ type ApplicationResponse struct

+ CreatedAt time.Time

+ Endpoints []EndpointResponse

+ Events int64

+ GroupID string

+ IsDisabled bool

+ Name string

+ SupportEmail string

+ UID string

+ UpdatedAt time.Time

+ type BatchResendRequest struct

+ IDs []string

type Convoy

+ Applications *Application

+ DeliveryAttempts *DeliveryAttempt

+ Endpoints *Endpoint

+ EventDeliveries *EventDelivery

+ Events *Event

+ Groups *Group

+ type CreateApplicationRequest struct

+ IsDisabled bool

+ Name string

+ SupportEmail string

+ type CreateEndpointRequest struct

+ Description string

+ Events []string

+ HttpTimeout string

+ RateLimit int

+ RateLimitDuration string

+ Secret string

+ URL string

+ type CreateEventRequest struct

+ AppID string

+ Data json.RawMessage

+ EventType string

+ type CreateGroupRequest struct

+ Group GroupConfig

+ LogoUrl string

+ Name string

+ RateLimit int

+ RateLimitDuration string

+ type DefaultStrategyConfiguration struct

+ IntervalSeconds uint64

+ RetryLimit uint64

+ type DeliveryAttempt struct

+ func (d *DeliveryAttempt) All(eventDeliveryId string, query *DeliveryAttemptQueryParam) (*ListDeliveryAttemptResponse, error)

+ func (d *DeliveryAttempt) Find(eventDeliveryId, deliveryAttemptId string, query *DeliveryAttemptQueryParam) (*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 Endpoint struct

+ func (e *Endpoint) All(appId string, query *EndpointQueryParam) (*ListEndpointResponse, error)

+ func (e *Endpoint) Create(appId string, opts *CreateEndpointRequest, query *EndpointQueryParam) (*EndpointResponse, error)

+ func (e *Endpoint) Delete(appId, endpointId string, query *EndpointQueryParam) error

+ func (e *Endpoint) Find(appId, endpointId string, query *EndpointQueryParam) (*EndpointResponse, error)

+ func (e *Endpoint) Update(appId, endpointId string, opts *CreateEndpointRequest, ...) (*EndpointResponse, error)

+ type EndpointMetadata struct

+ HttpTimeout string

+ RateLimit int

+ RateLimitDuration string

+ Secret string

+ Sent bool

+ Status string

+ TargetURL string

+ UID string

+ type EndpointQueryParam struct

+ GroupID string

+ type EndpointResponse struct

+ CreatedAt time.Time

+ Description string

+ Events []string

+ HttpTimeout string

+ RateLimit int

+ RateLimitDuration string

+ Secret string

+ Status string

+ TargetUrl string

+ UID string

+ UpdatedAt time.Time

+ type Event struct

+ func (e *Event) All(query *EventQueryParam) (*ListEventResponse, error)

+ func (e *Event) Create(opts *CreateEventRequest, query *EventQueryParam) (*EventResponse, error)

+ func (e *Event) Find(id string, query *EventQueryParam) (*EventResponse, error)

+ type EventDelivery struct

+ func (e *EventDelivery) All(query *EventDeliveryQueryParam) (*ListEventDeliveryResponse, error)

+ func (e *EventDelivery) BatchResend(opts *BatchResendRequest, query *EventDeliveryQueryParam) error

+ func (e *EventDelivery) Find(id string, query *EventDeliveryQueryParam) (*EventDeliveryResponse, error)

+ func (e *EventDelivery) Resend(id string, query *EventDeliveryQueryParam) (*EventDeliveryResponse, error)

+ type EventDeliveryQueryParam struct

+ AppID string

+ EventID string

+ GroupID string

+ Page int

+ PerPage int

+ type EventDeliveryResponse struct

+ AppMetadata AppMetadata

+ CreatedAt time.Time

+ Description string

+ EndpointMetadata EndpointMetadata

+ EventMetadata EventMetadata

+ Metadata Metadata

+ Status string

+ UID string

+ UpdatedAt time.Time

+ type EventMetadata struct

+ Name string

+ UID string

+ type EventQueryParam struct

+ AppID string

+ GroupID string

+ Page int

+ PerPage int

+ type EventResponse struct

+ AppMetadata AppMetadata

+ CreatedAt time.Time

+ Data json.RawMessage

+ EventType string

+ MatchedEndpoints int

+ ProviderID string

+ UID string

+ UpdatedAt time.Time

+ type ExponentialBackoffStrategyConfiguration struct

+ RetryLimit uint64

+ type Group struct

+ func (g *Group) All(query *GroupQueryParams) (*ListGroupResponse, error)

+ func (g *Group) Create(opts *CreateGroupRequest) (*GroupResponse, error)

+ func (g *Group) Delete(id string) error

+ func (g *Group) Find(id string) (*GroupResponse, error)

+ func (g *Group) Update(id string, opts *CreateGroupRequest) (*GroupResponse, error)

+ type GroupConfig struct

+ DisableEndpoint bool

+ ReplayAttacks bool

+ Signature SignatureConfiguration

+ Strategy StrategyConfiguration

+ type GroupQueryParams struct

+ GroupID string

+ Name string

+ type GroupResponse struct

+ CreatedAt time.Time

+ Group GroupConfig

+ LogoUrl string

+ Name string

+ RateLimit int

+ RateLimitDuration string

+ Statistics struct{ ... }

+ UID string

+ UpdatedAt time.Time

+ type HttpClient struct

+ func NewClient(opts Options) *HttpClient

+ func (c *HttpClient) SendRequest(opts *requestOpts) (interface{}, error)

+ type ListApplicationResponse struct

+ Content []ApplicationResponse

+ Pagination Pagination

+ type ListDeliveryAttemptResponse []DeliveryAttemptResponse

+ type ListEndpointResponse []EndpointResponse

+ type ListEventDeliveryResponse struct

+ Content []EventDeliveryResponse

+ Pagination Pagination

+ type ListEventResponse struct

+ Content []EventResponse

+ Pagination Pagination

+ type ListGroupResponse []GroupResponse

+ type Metadata struct

+ Data json.RawMessage

+ IntervalSeconds uint64

+ NextSendTime time.Time

+ NumTrials uint64

+ RetryLimit uint64

+ Strategy string

+ type Pagination struct

+ Next int

+ Page int

+ PerPage int

+ Prev int

+ Total int

+ TotalPage int

+ type QueryParameter struct

+ Parameters map[string]string

+ type SignatureConfiguration struct

+ Hash string

+ Header string

+ type StrategyConfiguration struct

+ Default DefaultStrategyConfiguration

+ ExponentialBackoff ExponentialBackoffStrategyConfiguration

+ Type string

v0.2.0

Apr 8, 2022

Changes in this version

type Convoy

+ func NewWithAPIKey(url, groupID, apiKey string) *Convoy

type Options

+ APIKey string

+ GroupID string

v0.1.5

Sep 17, 2021

Changes in this version

type Convoy

+ func (c *Convoy) UpdateApp(appID string, request *models.ApplicationRequest) (*models.ApplicationResponse, error)

v0.1.4

Sep 17, 2021

Changes in this version

+ const MethodGet

type Convoy

+ func (c *Convoy) GetApp(Id string) (*models.ApplicationResponse, error)

v0.1.3

Sep 17, 2021

v0.1.2

Sep 16, 2021

Changes in this version

+ const MethodPut

type Convoy

+ func (c *Convoy) UpdateAppEndpoint(appId string, request *models.EndpointRequest) (*models.EndpointResponse, error)

v0.1.1

Sep 16, 2021

Changes in this version

type Options

+ APIEndpoint string

v0.1.0

Sep 16, 2021

Changes in this version

+ const ApiEndpoint

+ const MethodPost

+ type Convoy struct

+ func New() *Convoy

+ func NewWithCredentials(username, password string) *Convoy

+ func (c *Convoy) CreateApp(request *models.ApplicationRequest) (*models.ApplicationResponse, error)

+ func (c *Convoy) CreateAppEndpoint(appId string, request *models.EndpointRequest) (*models.EndpointResponse, error)

+ func (c *Convoy) CreateAppEvent(appId string, request *models.EventRequest) (*models.EventResponse, error)

+ type HTTPClient interface

+ Do func(*http.Request) (*http.Response, error)

+ type Options struct

+ APIPassword string

+ APIUsername string

+ HTTPClient HTTPClient

Other modules containing this package

github.com/frain-dev/convoy-go/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL