accounts.webhooks.set REST

Skip to end of metadata
Go to start of metadata

 

Description

This method is used to create a new webhook or update an existing one.

To update an existing webhook, pass the name of the webhook to update, along with any relevant parameters.

Passing a new name with an existing url will return an error. To rename a webhook, first delete it, then create a new one.

 

 

Note: If you plan on integrating Gigya's Accounts API, we highly recommend reading the Registration-as-a-Service Guide. Registration-as-a-Service (RaaS) is a premium platform that requires separate activation. If RaaS is not part of your site package, please contact Gigya by filling in a support form through the Console. You can access the support page by clicking Support on the upper menu after logging into the Gigya Console.


 

Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.

 

Parameters

RequiredNameTypeDescription
urlstringThe callback URL to which webhook notifications will be delivered. This must be unique per site and HTTPS.
eventsstring

The event types to receive notifications for. Possible values are:

  • accountCreated
  • accountRegistered
  • accountUpdated
  • accountLoggedIn
  • accountDeleted

Pass multiple event types separated by commas.

{...
	"events":"accountCreated,accountRegistered",
...} 
namestring
The name of the webhook. This can be up to 100 characters long and must be unique per site.
activeBooleanIndicates whether the current webhook is active. When set to false, notifications will not be sent to this webhook.
signingUserKeystringThe userKey whose secret is used to sign the notification. Leave this parameter blank to sign notifications using the partner secret.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 

 

Response Data

FieldTypeDescription
 
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
statusReason string A brief explanation of the status code.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter and not always returned.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or

 

 

A field that does not contain data will not appear in the response.

 

Response Example

{
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "56db9dad98a1412b86084c2d34f93286",
  "time": "2016-08-10T06:20:30.490Z"
}