Skip to content

Commit f8aabd1

Browse files
committed
Simplifying the Graph API sample instructions
1 parent 19353c9 commit f8aabd1

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

heroku/README.md

+24-8
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,31 @@ This is a sample client for [Facebook's Graph API Webhooks](https://developers.f
44

55
## Setup
66

7-
### Heroku
8-
1. Deploy with this button: [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fbsamples/graph-api-webhooks-samples)
9-
1. Test your deployment with `curl https://<your-subdomain>.herokuapp.com` - you should see a list of received webhooks.
10-
1. For handling POST request validation (optional, but suggested), set the `APP_SECRET` [config var](https://devcenter.heroku.com/articles/config-vars) using your app secret value from your [Facebook app's settings](https://developers.facebook.com/apps).
11-
127
### Facebook
13-
1. Create a new [Facebook application](https://developers.facebook.com/apps).
14-
1. Set up your Facebook application's [Graph API Webhooks subscription](https://developers.facebook.com/docs/graph-api/webhooks/#setup) using `https://<your-subdomain>.herokuapp.com/facebook` as the callback URL. It is recommended that you set a `TOKEN` [config var](https://devcenter.heroku.com/articles/config-vars) as part of the set up of your Heroku app to secure requests. If you choose not to set a config var, then you will need to set a verify token of 'token' when configuring the callback URL.
8+
In order to use this sample app, you must have a [Facebook Developer](https://developers,facebook.com) account and a [Heroku](https://www.heroku.com) account.
9+
10+
1. Refer to Facebook's [Webhooks sample app documentation](https://developers.facebook.com/docs/webhooks/sample-apps) to see how to use this app.
11+
1. Deploy the sample app on Heroku with this button:
12+
13+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fbsamples/graph-api-webhooks-samples)
1514

1615
### Instagram
1716
1. Register an [Instagram API client](https://instagram.com/developer/clients/manage/).
18-
1. Set up your client's [subscription](https://www.instagram.com/developer/subscriptions/) using your `https://<your-subdomain>.herokuapp.com/instagram` as the callback URL. It is recommended that you set a `TOKEN` [config var](https://devcenter.heroku.com/articles/config-vars) as part of the set up of your Heroku app to secure requests. If you choose not to set a config var, then you will need to set a verify token of 'token' when configuring the callback URL.
17+
1. Deploy the sample app on Heroku with this button:
18+
19+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fbsamples/graph-api-webhooks-samples)
20+
21+
1. Enter a name for your app or let Heroku assign a random one. (The name of the app will become part of the callback URL.) Click **Deploy App**.
22+
1. After the app is deployed, click **Manage App** and select the **Settings** tab in the dashboard.
23+
1. Click **Reveal Config Vars**, and create a `APP_SECRET` [config var](https://devcenter.heroku.com/articles/config-vars) with your Facebook app's App Secret as the value. Then, create a `TOKEN` config var with whatever value you wish; this string is included in verification requests when you configure the Webhooks product in the App Dashboard (the app will validate the request on its own).
24+
25+
**Note:** It is recommended that you set a `TOKEN` config var as part of the set up of your Heroku app to secure requests. If you choose not to set a config var, then you will need to set a verify token of "token" when configuring the callback URL. The `APP_SECRET` config var is needed for handling `POST` request validation.
26+
27+
1. Set up your client's [subscription](https://www.instagram.com/developer/subscriptions/) using `https://<your-subdomain>.herokuapp.com/instagram` as the **Callback URL**. If you created a `TOKEN` config var enter it in the **Verify Token** field of the Webhook subscription settings.
28+
29+
## Testing
30+
If you wish to test that everything is working properly, you can send a test notification to your callback URL.
31+
32+
1. In the App Dashboard, go to **Products** > **Webhooks**.
33+
1. Click on a **Test** button for any of the Webhooks fields.
34+
1. A pop-up dialog will show you a sample response. Click **Send to My Server** to trigger the actual notification. You should see the Webhooks response at your callback URL in a web browser or by using `curl https://<your-subdomain>.herokuapp.com` from a terminal.

0 commit comments

Comments
 (0)