sgew

README

sgew

SendGrid Event Webhook Debugger

Requirements

export SENDGRID_API_KEY=xxx
export NGROK_AUTHTOKEN=xxx

Usage

❯ sgew --help
Usage: sgew <command>

SendGrid Event Webhook Debugger

Flags:
  -h, --help    Show context-sensitive help.

Commands:
  listen
    Listen for webhook events

  trigger --id=STRING --url=STRING
    trigger test webhook events

  ls
    List all event webhooks

Run "sgew <command> --help" for more information on a command.

List all event webhooks

+--------------------------------------+---------+------------------------------------------------------------------------------------------------------------------+------------------------------------------+--------------+
| ID                                   | ENABLED | URL                                                                                                              | FRIENDLY NAME                            | CREATED DATE |
+--------------------------------------+---------+------------------------------------------------------------------------------------------------------------------+------------------------------------------+--------------+
| 61d7a811-1855-41bc-a75c-d5ef9d1adefa | false   | https://receiver1.example.com                                                                                    | receiver1                                | 2023-10-24   |
+--------------------------------------+---------+------------------------------------------------------------------------------------------------------------------+------------------------------------------+--------------+
| b2b55c5d-d703-494c-b6c3-4618bfb5dee9 | true    | https://receiver2.example.com                                                                                    | receiver2                                | 2023-12-19   |
+--------------------------------------+---------+------------------------------------------------------------------------------------------------------------------+------------------------------------------+--------------+

See Also

• https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authentication
• https://ngrok.com/docs/agent/cli/

Documentation

Index

• type GetAllEventWebhooksOutput
• type ListenCmd
  • func (c *ListenCmd) Run() error
• type LsCmd
  • func (c *LsCmd) Run() error
• type TriggerCmd
  • func (c *TriggerCmd) Run() error

Types

type GetAllEventWebhooksOutput

type GetAllEventWebhooksOutput struct {
	Webhooks []struct {
		ID           string `json:"id"`
		CreatedDate  string `json:"created_date"`
		Enabled      bool   `json:"enabled"`
		FriendlyName string `json:"friendly_name"`
		URL          string `json:"url"`
	} `json:"webhooks"`
}

type ListenCmd

type ListenCmd struct {
}

func (*ListenCmd) Run

func (c *ListenCmd) Run() error

type LsCmd

type LsCmd struct {
}

func (*LsCmd) Run

func (c *LsCmd) Run() error

type TriggerCmd

type TriggerCmd struct {
	ID  string `name:"id" help:"The ID of the Event Webhook you want to retrieve." required:""`
	URL string `name:"url" help:"The URL where you would like the test notification to be sent." required:""`
}

func (*TriggerCmd) Run

func (c *TriggerCmd) Run() error