KEMBAR78
Webhooks | PPTX
Made by:- Submitted to:-
Miss Himani Kapadia
Avinash Singh
Bhavik solanki
Dishant soni
Dev patel
Jhill soni
Priyank Thada
A webhook in web development, is
a method of augmenting or altering
the behaviour of a web page, or web
application, with customs call
backs. These call backs may be
maintained, modified and managed
by third party users and developers
who may not necessarily affiliated
with the originating website or
application. The term “webhook”
was coined by Jeff Lindsay in 2007
from the computer programing
term hook.
Webhooks are user defined HTTP
call backs, they are triggered by
some event, such as pushing code to
repository or a comment being
posted to a blog. When that event
occurs, the source site makes an
HTTP request to the URL
configured from the webhook. User
can configure them to cause events
on one site to invoke behaviour on
another. The action takes may be
anything. Common uses are to
trigger builds with continuous
integration system or to notify bug
tracking system.
“XYZ” company wants to send some investment
related schemes to their new prospects. Once a
new prospect opens or clicks on any link inside
the email, then their internal CRM/call centre
software should get updated, so that their sales
executive can immediately call and acquire new
prospect.
Now, this can be done using third party vendor
to send emails . Here the third party is
FALCONIDE webhooks. It gives you immense
flexible to gather real time data directly on to
your system. Just specify a call-back URL on
falconide and as soon as a prospects click on
link an event will be triggered that will POST
the information to your specific URL
You can configure webhooks through falconide
account here are the basic steps:
1. Login to falconide account.
2. Navigate to settings-> API
3. Click the API menu option in the sidebar
sub menu
4. Click webhooks under API
5. Enter a valid callback URL where falconide
can POST the event data. As per your
business requirement, you can configure
webhooks for all or selected categories of
events.
1. If your system are behind a firewall
that blocks access to all traffic except
for certain domains then your
network has to grant access to
falconide.com, in order for the
webhooks to function correctly, the
administrators of your network will
have to allow all the following range
of IPs on your network.
2. Your webhooks URLs should be set
up to accept the POST request coming
from our falconide server. When you
provide the URL where you want
falconide to POST the data for events
we'll do a quick check that the URL
exists by using a HEAD request (not
POST).
When an event occur that you have
specified a callback URL for,
webhook will send a HTTP POST
request to the URL you’ve specified
and it will do its best to deliver the
events to your endpoint. But, if that
URL is unavailable or takes to long
to respond , we’ll cancel the request
and dispatcher will attempt several
retries until the maximum retry
limit of 5 is reached.
1. TRANSID  Falconide assigns a
Unique ID transaction for each and
every emails which were sent.
2. EMAIL  Recipient’s email ID
3. Event  Type of event:
delivered/dropped/invalid/bounced/
opened/clicked/ unsubscribed/spam.
4. RESPONSE  response received from
the end server like delivery, logs,
bounced reason, reason for drop
(blacklisted user/already
unsubscribed).
5. X- APIHEADER  Information
passed by you in the APIHEADER,
during the time of email sent.
6. TIMESTAMP  Unix
TIMESTAMP of the occurrence of
the event.
7. USERAGENT  User agent
contains the detailed information
about the browser from where a
specific event is initiated.
8. IPADDRESS  IP address of the
device from where the recipient has
responded.
Webhook currently support on
number of events, which are
detailed below:
• Delivered
• Dropped
• Invalid
• Bounced
• Opened
• Clicked
• Unsubscribed
TRANSI
D
EMAIL EVEN
T
RESPONS
E
X-
APIHEADE
R
TIMES
TAMP
19898796752
6
test@gmail.co
m
DELIVER
ED
175.158.64.3
9->250 2.0
OK
ACC12312 1358402
419
1. Delivered
Email has been successfully delivered to the
receiving server
2. Dropped
Users who have already unsubscribed in
past or blacklisted because of hard
bounce complaints will be treated as
dropped. And no further communication
is allowed on this type of rid.
TRANSI
D
EMAIL EVEN
T
RESPONS
E
X-
APIHEAD
ER
TIMES
TAMP
19898796752
6
test@gmail.co
m
DROPPE
D
Blacklisted
user /
already
unsubscribe
d
ACC12312 1358402
419
3. INVALID
All API requests with syntactically incorrect
email ids will be treated as invalid and no
further processing will be done on such ids. You
can capture all such invalid events in real time
and try correcting them offline.
TRANSI
D
EMAIL EVEN
T
RESPONS
E
X-
APIHEADE
R
TIMES
TAMP
19898796752
6
test@gmail.co
m
INVALID Invalid
Email
Address
ACC12312 1358402
419
4. BOUNCED
Receiving server could not or would not
accept message because of multiple
reasons like receiving server is not
reachable, email id doesn’t exist etc.
TRANSI
D
EMAIL EVEN
T
RESPONS
E
X-
APIHEADE
R
TIMES
TAMP
19898796752
6
test@gmail.co
m
BOUNCE
D
550 5.1.1
email
account
doesn’t
exist
ACC12312 1358402
419
5. OPENED
Recipient has opened all emails
TRANSI
D
EMAIL EVEN
T
RESPONS
E
X-
APIHEADE
R
TIMES
TAMP
19898796752
6
test@gmail.co
m
DELIVER
ED
175.158.64.3
9->250 2.0
OK
ACC12312 1358402
419
6. CLICKED
Recipient has clicked on a link within a message.
TRANSI
D
EMAIL EVEN
T
RESPONS
E
X-
APIHEADE
R
TIMES
TAMP
19898796752
6
test@gmail.co
m
CLICKED 175.158.64.3
9->250 2.0
OK
BC12311 1358402
419
7. UNSUBSCRIBED
Recipient clicked on unsubscribed
management link.
TRANSI
D
EMAIL EVENT RESP
ONSE
X-
APIHEAD
ER
TIMES
TAMP
19898796752
6
test@gmail.co
m
UNSUBSCRIB
ED
175.158.6
4.39-
>250 2.0
OK
ACC12312 1358402
419
Below is a sample script which needs to be
written at your end for collecting the event data
posted by Webhooks. This is language as well as
platform independent. You can write script in
any programming language and collect the data.
<?php
$fp=fopen(‘/tmp/weblog.txt’,’a’);
Foreach($_POST as $key=>$val) {
Fwrite($fp,”$key=>$val”);
}
Fwrite($fp,”n”);
fclose($fp);
?>
Webhooks

Webhooks

  • 1.
    Made by:- Submittedto:- Miss Himani Kapadia Avinash Singh Bhavik solanki Dishant soni Dev patel Jhill soni Priyank Thada
  • 2.
    A webhook inweb development, is a method of augmenting or altering the behaviour of a web page, or web application, with customs call backs. These call backs may be maintained, modified and managed by third party users and developers who may not necessarily affiliated with the originating website or application. The term “webhook” was coined by Jeff Lindsay in 2007 from the computer programing term hook.
  • 3.
    Webhooks are userdefined HTTP call backs, they are triggered by some event, such as pushing code to repository or a comment being posted to a blog. When that event occurs, the source site makes an HTTP request to the URL configured from the webhook. User can configure them to cause events on one site to invoke behaviour on another. The action takes may be anything. Common uses are to trigger builds with continuous integration system or to notify bug tracking system.
  • 4.
    “XYZ” company wantsto send some investment related schemes to their new prospects. Once a new prospect opens or clicks on any link inside the email, then their internal CRM/call centre software should get updated, so that their sales executive can immediately call and acquire new prospect. Now, this can be done using third party vendor to send emails . Here the third party is FALCONIDE webhooks. It gives you immense flexible to gather real time data directly on to your system. Just specify a call-back URL on falconide and as soon as a prospects click on link an event will be triggered that will POST the information to your specific URL
  • 6.
    You can configurewebhooks through falconide account here are the basic steps: 1. Login to falconide account. 2. Navigate to settings-> API 3. Click the API menu option in the sidebar sub menu 4. Click webhooks under API 5. Enter a valid callback URL where falconide can POST the event data. As per your business requirement, you can configure webhooks for all or selected categories of events.
  • 8.
    1. If yoursystem are behind a firewall that blocks access to all traffic except for certain domains then your network has to grant access to falconide.com, in order for the webhooks to function correctly, the administrators of your network will have to allow all the following range of IPs on your network. 2. Your webhooks URLs should be set up to accept the POST request coming from our falconide server. When you provide the URL where you want falconide to POST the data for events we'll do a quick check that the URL exists by using a HEAD request (not POST).
  • 9.
    When an eventoccur that you have specified a callback URL for, webhook will send a HTTP POST request to the URL you’ve specified and it will do its best to deliver the events to your endpoint. But, if that URL is unavailable or takes to long to respond , we’ll cancel the request and dispatcher will attempt several retries until the maximum retry limit of 5 is reached.
  • 10.
    1. TRANSID Falconide assigns a Unique ID transaction for each and every emails which were sent. 2. EMAIL  Recipient’s email ID 3. Event  Type of event: delivered/dropped/invalid/bounced/ opened/clicked/ unsubscribed/spam. 4. RESPONSE  response received from the end server like delivery, logs, bounced reason, reason for drop (blacklisted user/already unsubscribed).
  • 11.
    5. X- APIHEADER Information passed by you in the APIHEADER, during the time of email sent. 6. TIMESTAMP  Unix TIMESTAMP of the occurrence of the event. 7. USERAGENT  User agent contains the detailed information about the browser from where a specific event is initiated. 8. IPADDRESS  IP address of the device from where the recipient has responded.
  • 12.
    Webhook currently supporton number of events, which are detailed below: • Delivered • Dropped • Invalid • Bounced • Opened • Clicked • Unsubscribed
  • 13.
  • 14.
    2. Dropped Users whohave already unsubscribed in past or blacklisted because of hard bounce complaints will be treated as dropped. And no further communication is allowed on this type of rid. TRANSI D EMAIL EVEN T RESPONS E X- APIHEAD ER TIMES TAMP 19898796752 6 test@gmail.co m DROPPE D Blacklisted user / already unsubscribe d ACC12312 1358402 419
  • 15.
    3. INVALID All APIrequests with syntactically incorrect email ids will be treated as invalid and no further processing will be done on such ids. You can capture all such invalid events in real time and try correcting them offline. TRANSI D EMAIL EVEN T RESPONS E X- APIHEADE R TIMES TAMP 19898796752 6 test@gmail.co m INVALID Invalid Email Address ACC12312 1358402 419
  • 16.
    4. BOUNCED Receiving servercould not or would not accept message because of multiple reasons like receiving server is not reachable, email id doesn’t exist etc. TRANSI D EMAIL EVEN T RESPONS E X- APIHEADE R TIMES TAMP 19898796752 6 test@gmail.co m BOUNCE D 550 5.1.1 email account doesn’t exist ACC12312 1358402 419
  • 17.
    5. OPENED Recipient hasopened all emails TRANSI D EMAIL EVEN T RESPONS E X- APIHEADE R TIMES TAMP 19898796752 6 test@gmail.co m DELIVER ED 175.158.64.3 9->250 2.0 OK ACC12312 1358402 419
  • 18.
    6. CLICKED Recipient hasclicked on a link within a message. TRANSI D EMAIL EVEN T RESPONS E X- APIHEADE R TIMES TAMP 19898796752 6 test@gmail.co m CLICKED 175.158.64.3 9->250 2.0 OK BC12311 1358402 419
  • 19.
    7. UNSUBSCRIBED Recipient clickedon unsubscribed management link. TRANSI D EMAIL EVENT RESP ONSE X- APIHEAD ER TIMES TAMP 19898796752 6 test@gmail.co m UNSUBSCRIB ED 175.158.6 4.39- >250 2.0 OK ACC12312 1358402 419
  • 20.
    Below is asample script which needs to be written at your end for collecting the event data posted by Webhooks. This is language as well as platform independent. You can write script in any programming language and collect the data. <?php $fp=fopen(‘/tmp/weblog.txt’,’a’); Foreach($_POST as $key=>$val) { Fwrite($fp,”$key=>$val”); } Fwrite($fp,”n”); fclose($fp); ?>