README
¶
Go client for Posthook API
Implements the API documented at https://docs.posthook.io/
Install with go get -u github.com/pims/posthook
example use:
// create posthook client
ph := posthook.New(os.Getenv("POSTHOOK_API_KEY"))
// verify the endpoint being used
fmt.Println(ph.Endpoint())
// data to be sent back to us when posthook executes the hook
data := map[string]interface{}{
"foobar": "baz",
}
// Step 1: schedule a hook
hook, err := ph.Schedule("ping", time.Now().Add(1*time.Minute).UTC(), data)
handleErr(err)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client interfaces with the Posthook API: api.posthook.io
func (*Client) Delete ¶
Delete a Hook. This will stop Posthook from making the request back to your application for this Hook.
type Config ¶
type Config func(c *Client)
Config lets users configure the postHook struct
func WithEndpoint ¶
WithEndpoint configures the API endpoint
func WithHTTPClient ¶
WithHTTPClient replaces the underlying http.DefaultClient
type Filters ¶
type Filters struct {
Limit *int `url:"limit,omitempty"`
SortBy *string `url:"sortBy,omitempty"`
SortOrder *string `url:"sortOrder,omitempty"`
PostAtBefore *time.Time `url:"postAtBefore,omitempty"`
PostAtAfter *time.Time `url:"postAtAfter,omitempty"`
CreatedBefore *time.Time `url:"createdBefore,omitempty"`
CreatedAfter *time.Time `url:"createdAfter,omitempty"`
}
Filters lets you filter a list query
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.