Building webhooks with NodeJS

joncipriano · 2017-06-14T23:03:27.879Z

Here is a NodeJS webapp using express with example scripts and directions for configuring your webhook.

GitHub

twitterdev/twitter-webhook-boilerplate-node

twitter-webhook-boilerplate-node - A simple Node.js app using Express 4 for Twitter DMs and webhooks.

pazpurua · 2017-06-15T02:13:50.695Z

Jon great work.
In one week or to two I will start to create the node project.

Yours Pedro

pazpurua · 2017-06-16T11:24:49.509Z

I am starting from zero. But I have a first question: Where do i get the WEBHOOK_ID?
Yours Pedro

pazpurua · 2017-06-16T13:30:18.390Z

First step done: I have sent the new DM

postDM: function (DM,callback){
        var twitter_oauth = {
            consumer_key: config.consumer_key,
            consumer_secret: config.consumer_secret,
            token: config.access_token,
            token_secret: config.access_token_secret
        }
        var gsilva = "160334298"
        var pazpurua = "45031619"
        // direct message request body
        var dm_params = {
            "event": {
                "type": "message_create",
                "message_create": {
                    "target": {
                        "recipient_id": pazpurua
                    },
                    "message_data": {
                        "text": "Roberto Bienvenido al la lucha. Verifiquemos Sus Datos de Registro?",
                        "quick_reply": {
                            "type": "options",
                            "options": [
                                {
                                    "label": "Cedula",
                                    "description": "Es su Cedula V3883736",
                                    "metadata": "external_id_1"
                                },
                                {
                                    "label": "Correo",
                                    "description": "Es su correo el rpiconh@unidad.org",
                                    "metadata": "external_id_2"
                                },
                                {
                                    "label": "Celular",
                                    "description": "El celular 0412 2332 3232 es el suyo?.",
                                    "metadata": "external_id_3"
                                },
                                {
                                    "label": "Telefono",
                                    "description": "El Telefono 0212 929292929 es el suyo?.",
                                    "metadata": "external_id_4"
                                }
                            ]
                        }
                    }
                }
            }
        }

        // request options
        var request_options = {
            url: 'https://api.twitter.com/1.1/direct_messages/events/new.json',
            oauth: twitter_oauth,
            json: true,
            headers: {
                'content-type': 'application/json'
            },
            body: dm_params
        }

        // POST request to send Direct Message
        request.post(request_options, function (error, response, body) {
            var ppa = body;
            console.log(body)
            callback(null, body);
        })
    },

joncipriano · 2017-06-16T21:30:45.422Z

Hey @pazpurua,

The webhook ID is returned from POST account_activity/webhooks or the following node script:

github.com

twitterdev/twitter-webhook-boilerplate-node/blob/master/example_scripts/webhook_management/create-webhook-config.js

var nconf = require('nconf')
var request = require('request')


// load config
nconf.file({ file: 'config.json' }).env()

// twitter authentication
var twitter_oauth = {
  consumer_key: nconf.get('TWITTER_CONSUMER_KEY'),
  consumer_secret: nconf.get('TWITTER_CONSUMER_SECRET'),
  token: nconf.get('TWITTER_ACCESS_TOKEN'),
  token_secret: nconf.get('TWITTER_ACCESS_TOKEN_SECRET')
}

var WEBHOOK_URL = 'https://your-webhook-url'


// request options
var request_options = {

This file has been truncated. show original

If you create a webhook config, but didn’t note the config ID, you can retrieve it with GET account_activity/webhooks or the this node script:

github.com

twitterdev/twitter-webhook-boilerplate-node/blob/master/example_scripts/webhook_management/get-webhook-config.js

var nconf = require('nconf')
var request = require('request')


// load config
nconf.file({ file: 'config.json' }).env()

// twitter authentication
var twitter_oauth = {
  consumer_key: nconf.get('TWITTER_CONSUMER_KEY'),
  consumer_secret: nconf.get('TWITTER_CONSUMER_SECRET'),
  token: nconf.get('TWITTER_ACCESS_TOKEN'),
  token_secret: nconf.get('TWITTER_ACCESS_TOKEN_SECRET')
}


// request options
var request_options = {
  url: 'https://api.twitter.com/1.1/account_activity/webhooks.json',
  oauth: twitter_oauth

This file has been truncated. show original

pazpurua · 2017-06-17T22:38:22.537Z

oooops
I received the error
in the setup:

"{“errors”:[{“code”:214,“message”:"Webhook URL does not meet the requirements. Please consult: https://dev.twitter.com/webhooks/securing"}]}"

postSETUP: function (req, callback) {
   
        var twitter_oauth = {
            consumer_key: config.consumer_key,
            consumer_secret: config.consumer_secret,
            token: config.access_token,
            token_secret: config.access_token_secret
        }
       var WEBHOOK_URL = 'https://nodechatbotjson.azurewebsites.net/webhook/twitter'
       // request options
       var  request_options = {
            url: 'https://api.twitter.com/1.1/account_activity/webhooks.json',
            oauth: twitter_oauth,
            headers: {
                'Content-type': 'application/x-www-form-urlencoded'
            },
            form: {
                url: WEBHOOK_URL
            }
        }
        // POST request to send Direct Message
         request.post(request_options, function (error, response, body) {
            callback(null, body);
        })
},

FreeWillaert · 2017-06-23T20:56:39.755Z

I wrote about using webhooks with NodeJS running on AWS lambda:
https://www.linkedin.com/pulse/handling-twitter-webhooks-aws-lambda-step-functions-frederik-willaert

It’s pretty extensive but should contain some answers for you.

pazpurua · 2017-06-27T13:31:02.536Z

Excellent work. I have tryied with some of your ideas but i still get "{“errors”:[{“code”:214,“message”:"Webhook URL does not meet the requirements. Please consult: https://dev.twitter.com/webhooks/securing"}]}"

And I am stopped

Yours Pedro

andypiper · 2017-06-27T13:41:26.378Z

As you will see on that page…

Response requirements

Valid response_token and JSON format.

Latency less than 1 second.

200 HTTP response code.

Have you verified that your webhook is fulfilling all of these? I was not able to test it as it does not appear to be at the URL you listed above.

pazpurua · 2017-06-28T12:28:07.035Z

We have this response
{“fecha”:“Wed Jun 28 2017 12:26:21 GMT+0000 (Coordinated Universal Time)”,“nombre”:“prueba post en webhook/twitter”}
less than a second

Is it important the 200 HTTP? How do I build this message. Please

Yours Pedro

andypiper · 2017-06-28T12:29:44.650Z

You need to be responding with a CRC token as described in the docs and shown in the example project.

pazpurua · 2017-06-28T23:09:45.097Z

I have less tha a second
200 http
a jason

app.post(’/webhook/twitter’, function (request, response) {
var fecha = new Date()
//var respuesta = { “fecha”: fecha.toString(), “nombre”: “prueba post en webhook/twitter” }
var respuesta = { “status”: 200, “data”: “Webhook URL ok” }

//var respuesta=request.body
response.end(200,JSON.stringify(respuesta));
//azurefunctions.postWEBHOOK(respuesta, function (err, flag) {
//   // response.end(JSON.stringify(respuesta));
//    response.end(respuesta);
//})

});

NOTHING still get
"{“errors”:[{“code”:214,“message”:"Webhook URL does not meet the requirements. Please consult: https://dev.twitter.com/webhooks/securing"}]}"

andypiper · 2017-06-28T23:51:26.333Z

You are not responding in the JSON response with a CRC token as documented. If the call response is not correct then this may be the result.

We are trying hard to help you, and the documentation and sample is there. We would appreciate it if you can look into this on your side.

I’ll also remind you that this particular API is in beta and brand new - so you should expect reference code to be limited, we don’t have lots of time to walk you through issues, and that functionality may change as we develop.

Thanks!

pazpurua · 2017-06-30T15:25:51.596Z

Thanks. I am using the following documentation and there is no crc token?

github.com

twitterdev/twitter-webhook-boilerplate-node/blob/master/example_scripts/webhook_management/create-webhook-config.js

var nconf = require('nconf')
var request = require('request')


// load config
nconf.file({ file: 'config.json' }).env()

// twitter authentication
var twitter_oauth = {
  consumer_key: nconf.get('TWITTER_CONSUMER_KEY'),
  consumer_secret: nconf.get('TWITTER_CONSUMER_SECRET'),
  token: nconf.get('TWITTER_ACCESS_TOKEN'),
  token_secret: nconf.get('TWITTER_ACCESS_TOKEN_SECRET')
}

var WEBHOOK_URL = 'https://your-webhook-url'


// request options
var request_options = {

This file has been truncated. show original

Yours Pedro

andypiper · 2017-06-30T15:54:29.354Z

That’s only one part of the code. That’s the piece where you register the webhook callback. You also need a server listening, ready to respond when our side calls you to check for a valid set of criteria (response time and CRC token).

pazpurua · 2017-07-03T17:05:59.715Z

We have an endpoint for the webhhok. But I dont know how to get the crc

app.post(’/webhook/twitter’, function (request, response) {
var fecha = new Date()
//var respuesta = { “fecha”: fecha.toString(), “nombre”: “prueba post en webhook/twitter” }
var respuesta = { “status”: 200, “data”: “Webhook URL ok” }

//var respuesta=request.body
response.end(300,JSON.stringify(respuesta));
//azurefunctions.postWEBHOOK(respuesta, function (err, flag) {
//   // response.end(JSON.stringify(respuesta));
//    response.end(respuesta);
//})

});

Perhaps you coul explain
PPA

tahultagove · 2017-09-15T12:43:41.507Z

Hello pazpurua,

Please review guide of security and that you have to implement on you webhook get request.
Below is my code where I got verified my webhook.

var crypto = require(‘crypto’);
var hmac = crypto.createHmac(‘sha256’, _environment.env.config.twitter.consumer_secret);
app.get(’/twitter/webhook’, function (req, res) {
var reqQuery = req.query;
hmac.update(reqQuery.crc_token);
var sha256_hash_digest = hmac.digest(‘base64’);
res.status(200).send({ “response_token”: “sha256=” + sha256_hash_digest });
});

pazpurua · 2017-12-02T22:26:01.367Z

Hello. I have been in other matters and I am back.
We have included in our server. https://github.com/twitterdev/twitter-webhook-boilerplate-node/blob/master/example_scripts/webhook_management/update-wehbhook-url.js

And when we execute the createConfig() we obtain the following message: {“errors”:[{“code”:32,“message”:“Could not authenticate you.”}]}

We have the get and post for the webhhok url.

Yours Pedro

pazpurua · 2017-12-03T12:50:40.260Z

I have noticed that the getConfig() already says that {“code”:32,“message”:“Could not authenticate you.”

function getConfig() {
// request options
console.log(“getConfig()”)
var request_options = {
url: ‘https://api.twitter.com/1.1/account_activity/webhooks.json’,
oauth: twitter_oauth
}

// GET request to retreive webhook config
request.get(request_options, function (error, response, body) {
    var configs = JSON.parse(body)

    if (configs.length > 0) {
        current_config = configs[0]
        console.log(current_config)
        removeSubscription(current_config.id);
    } else {
        console.log('App does not have a webhook config.')
        createConfig()
    }
})

}

pazpurua · 2017-12-04T22:20:32.942Z

Hello. Everything is working. Thanks to cipriano and tahaultuvagove and garethx

Yours Pedro