SAP Customer Data Cloud Positions

accounts.webhooks.getStatus REST

Skip to end of metadata
Go to start of metadata

Description

This method is used to check the status of a defined webhook, including the time the last bulk was sent from the Gigya servers and the status received for them from the downstream system. We recommend calling accounts.webhooks.getAll beforehand, to get the correct URL for your webhook notifications. Note that URLs are case sensitive. 

This method is not supported for Global Access implementations.

 

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

RequiredNameType

Description

urlstringThe callback URL to which webhook notifications are delivered. This value is case-sensitive.
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.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
ignoreInterruptions Boolean This may be used in some cases to suppress logic applied by the Web SDK, such as automatic opening of screens (e.g., in a registration completion scenario). This parameter may not be used with REST APIs.
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.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

 

Response Data

FieldTypeDescription
webhookStatusJSON object

An object that indicates the status of the webhook, made up of the following fields:

  • statusCode (integer): The code of the received status.
  • lastSent (string): The time at which the notification service attempted to send the event to the specified URL. This will not appear if the message is "No Webhook activity was found".
  • message (string): Details related to the status. This will not be displayed in the case of a "200" (OK) response.
 
apiVersion integer Defines the API version that returned the response and may not always be returned.
callId string Unique identifier of the transaction, for debugging purposes.
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.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
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.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.

 

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

 

Response Example

See below for possible responses that are received for this method: 


"OK" Response Example

{
  "callId": "8e5a0700cdae4f53a906ec953ee53766",
  "errorCode": 0,
  "apiVersion": 2,
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2020-03-16T08:19:13.697Z",
  "webhookStatus": {
    "lastSent": "2020-03-15T16:39:31.549Z",
    "statusCode": 200
  }
} 


Customer Failure

{
  "callId": "3e9a07694bc245b1b19249310510503a",
  "errorCode": 0,
  "apiVersion": 2,
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2020-03-16T08:20:43.196Z",
  "webhookStatus": {
    "lastSent": "2020-03-16T08:11:42.594Z",
    "message": "NotFound",
    "statusCode": 404
  }
}

 

Timeout

{
  "callId": "4912645832494a55922a6b384b5f8716",
  "errorCode": 0,
  "apiVersion": 2,
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2020-03-16T08:21:57.984Z",
  "webhookStatus": {
    "lastSent": "2020-03-16T08:11:42.594Z",
    "message": "Timed out while waiting for response",
    "statusCode": 504
  }
}

 

New URL- No Webhook Activity

{
  "callId": "b5491ff5a7634115abd81572edcf5c51",
  "errorCode": 0,
  "apiVersion": 2,
  "statusCode": 200,
  "statusReason": "OK",
  "time": "2020-03-16T08:18:12.448Z",
  "webhookStatus": {
    "message": "No Webhook activity was found",
    "statusCode": 200
  }
}

 

Webhook Does Not Exist 

{
  "callId": "fabdbd92bb6549eeac3ddf544ad45882",
  "errorCode": 404000,
  "errorDetails": "Webhook URL is not defined on the site",
  "errorMessage": "Not found",
  "apiVersion": 2,
  "statusCode": 404,
  "statusReason": "Not Found",
  "time": "2020-03-18T07:08:17.938Z"
}