webhook

command
v0.14.1-0...-14c41cf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 2, 2021 License: MIT Imports: 2 Imported by: 0

README

Example: Webhooks

This is an example project that demonstrates how to use the webhooks feature on Nylas. When you run the app and set up a webhook with Nylas, it will print out some information every time you receive a webhook notification from Nylas.

In order to successfully run this example, you need to do the following things:

Get a client ID & client secret from Nylas

To do this, make a Nylas Developer account. You should see your client ID and client secret on the dashboard, once you've logged in on the Nylas Developer website.

Update the main.go File

Open the main.go file in this directory, and replace the example client secret with the real values that you got from the Nylas Developer dashboard.

Set Up HTTPS

Nylas requires that all webhooks be delivered to the secure HTTPS endpoints, rather than insecure HTTP endpoints. There are several ways to set up HTTPS on your computer, but perhaps the simplest is to use ngrok, a tool that lets you create a secure tunnel from the ngrok website to your computer. Install it from the website, and then run the following command:

ngrok http 8080

Notice that ngrok will show you two "forwarding" URLs, which may look something like http://ed90abe7.ngrok.io and https://ed90abe7.ngrok.io. (The hash subdomain will be different for you.) You'll be using the second URL, which starts with https.

Run the Example

go run main.go

Set the Nylas Callback URL

Now that your webhook is all set up and running, you need to tell Nylas about it. On the Nylas Developer console, click on the "Webhooks" tab on the left side, then click the "Add Webhook" button.

Paste your HTTPS URL into text field.

Then click the "Create Webhook" button to save.

Trigger events and see webhook notifications!

Send an email on an account that's connected to Nylas. In a minute or two, you'll get a webhook notification with information about the event that just happened!

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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