Gigya Job Openings

Webhook Object

Skip to end of metadata
Go to start of metadata

 

Description

A webhook object contains details of a defined webhook, including the events that were set to trigger notifications.

 

Parameters

FieldTypeDescription
urlstringThe callback URL to which webhook notifications will be delivered. This must be unique per site.
namestringThe name of the webhook. This can be up to 100 characters long and must be unique per site.
eventsarray of strings

An array of JSON objects, each one consisting of:

  • type - The event type. Possible values are:
    • accountCreated
    • accountRegistered
    • accountUpdated
    • accountDeleted
    • accountLoggedIn
    • accountLockedOut
    • subscriptionUpdated
  • id - A unique identifier for this event.

     

    Since events may be sent more than once, use the id to check for duplicates. The id for a specific event will always be the same.

  • timestamp - The GMT time when the event was triggered, in UNIX time format, i.e., the number of seconds since Jan. 1st 1970.

  • data - A JSON object containing:

    • uid - The UID of the user for which the event was triggered.

    • emailAccountToken - This is only returned in a subscriptionUpdated webhook. The token needed for various lite account related operations to avoid using the user's actual email address in requests.

.
activeBooleanIndicates whether the current webhook is active. When set to False, notifications will not be sent to this webhook.
headersJSON object

A list of name-value pairs of custom HTTP headers defined for this webhook.

 "headers": [
       {
         "name": "N1",
         "value": "v1"
       }
     ]
signingUserKeystringThe user key whose secret is used to sign the notification. Leave this parameter blank to sign notifications using the partner secret.
versionstringThe version number of this webhook. Different versions of webhooks may cause different data to be sent in the webhook notification. For supported versions and their impact, see Webhooks.
  • No labels