- URL:
- https://<root>/services/<serviceName>.<serviceType>/webhooks/<webhookID>/notificationStatus
- Methods:
GET- Version Introduced:
- 11.2
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The notification resource returns a list of timestamp information for when an attempt to deliver a payload has failed. A failure is reached when the number of attempts made to deliver the webhook payload to the receiver has been met and no response has been received from the receiver. When the maximum number of allowed failures is met, the webhook will be deactivated. This resource can be cleared of the logged failures by deactivating and reactivating the service webhooks for a specific service. For more information on delivery attempts and the deactivation policy, see the Settings operation documentation.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usages
The following is a sample request URL used to access the notification resource for a geoprocessing service webhook:
https://organization.example.com/<context>/admin/services/gp_webhook_1.GPServer/webhooks/cc7a09a9-011d-47d7-a3d2-2769b55b0332/notificationStatus?f=pjsonJSON Response example
{
"webhookNotificationStatus": [
{
"invoked": false,
"invokedTimestamp": 1695756823000
}
]
}