Description

Hook sent when a incoming email is successfully authenticated.

Response Fields

Field Description
type Indicates the type of hook. For then authenication successful hook, it's always "authentication success".
authentication A unique ID for this authenication. Will look something like "62ABACBC-DF87-49A3-8642-1F860CCDFCC5".
button A unique ID for the button used. Will look something like "2477978A-6B67-48EA-BCB1-5616DE05FBD2".
account Your account ID. Will look something like "m_hOtXcnvLOGmjJt6kdU10aQ".
date The Unix time stamp of when the authenication occurred.
incoming_email The email address the authenication request came from.
expected_email The email address the authenication was suppose to come from (if it was provided when the button was created).
$CUSTOM Any custom key/value pairs that were suppose in at button creation will be included here.

Example Hook

  details: 
  {
    "type":"authentication success",
    "authentication":"62ABACBC-DF87-49A3-8642-1F860CCDFCC5",
    "button":"2477978A-6B67-48EA-BCB1-5616DE05FBD2",
    "account":"m_hOtXcnvLOGmjJt6kdU10aQ",
    "date":1500656895,
    "incoming_email":"user1@example.com",
    "expected_email":"user1@example.com",
    "amount":1,
    "invoice_number":1001
  }
  signature: f4e7330899b505bbdba2315e9d5b9f695e4aecc7