- URL:
- https://<WebHooks-url>/Webhooks
- Methods:
POST- Version Introduced:
- June, 2020
Description
Each event type has a specific payload format with the relevant event information. In addition to the information that is relevant to each event, all event webhook payloads include information about the layer and the feature service that the event occurred on.
The table below describes the properties included in payloads for the webhooks that you create on hosted feature layer, hosted feature layer views, or hosted tables. The payload includes information about changes made to the layer or table's source feature service. The payload is an HTTPS POST request delivered in a JSON schema.
Request parameters
| Property | Details |
|---|---|
name | The name of the webhook. |
layer | The ID of the webhook that delivered the payload. |
org | The ID of the ArcGIS Online organization where the webhook is stored. |
service | The name of the feature service that powers the feature layer or table. The name was defined when the web layer was published. |
last | The timestamp (formatted as miliseconds since epoch) whn the event occurred. |
changes | The URL to the Extract Changes endpoint for the items's source feature service. You can access this URL to learn more about the specific changes that occurred during the event. |
events | The event type that was performed. Values are listed in the Feature layer evnent triggers. |
f | The response format. The default response format is Values: |
JSON Response examples for single event payloads
The following are examples of single event payloads:
- Example one: FeaturesCreated event
- Example two: FeaturesUpdated event
- Example three: FeaturesDeleted
- Example four: FeaturesEdited event
- Example five: AttachmentsCreated event
- Example six: AttachmentsUpdated event
- Example seven: AttachmentsDeleted event
- Example eight: LayerSchemaChanged event
- Example nine: LayerDefinitionChanged event
- Example ten: FeatureServiceDefinitionChanged event
The following are examples of multiple event payloads:
- Example one: FeaturesUpdated and FeaturesCreated events
- Example two: ServiceDefinitionChanged and LayerDefinitionChanged events
Example one: FeaturesCreated event
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1629325549649,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[21891591,25166741]&async=true&returnUpdates=false&returnDeletes=false&returnAttachments=false",
"events": ["FeaturesCreated"]
}
]Example two: FeaturesUpdated event
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[25166748,25166760]&async=true&returnDeletes=false&returnAttachments=false",
"events": ["FeaturesUpdated"]
}
]Example three: FeaturesDeleted
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[25166742,25166748]&async=true&returnInserts=false&returnUpdates=false&returnAttachments=false",
"events": ["FeaturesDeleted"]
}
]Example four: FeaturesEdited event
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[25166742,25166748]&async=true&returnInserts=false&returnUpdates=false&returnAttachments=false",
"events": ["FeaturesEdited"]
}
]Example five: AttachmentsCreated event
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1632442947760,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[21891591,25166796]&async=true&returnInserts=false&returnUpdates=false&returnDeletes=false",
"events": ["AttachmentsCreated"]
}
]Example six: AttachmentsUpdated event
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1632442947760,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[21891591,25166796]&async=true&returnInserts=false&returnUpdates=false&returnDeletes=false",
"events": ["AttachmentsUpdated"]
}
]Example seven: AttachmentsDeleted event
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[25166797,25166802]&async=true&returnInserts=false&returnUpdates=false&returnDeletes=false",
"events": ["AttachmentsDeleted"]
}
]Example eight: LayerSchemaChanged event
[
{
"name": "webhookname",
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"events": ["LayerSchemaChanged"]
}
]Example nine: LayerDefinitionChanged event
[
{
"name": "webhookname",
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"events": ["LayerDefinitionChanged"]
}
]Example ten: FeatureServiceDefinitionChanged event
[
{
"name": "webhookname",
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"events": ["FeatureServiceDefinitionChanged"]
}
]JSON Response examples of multiple event payloads
The following are examples of multiple event payloads:
Example one: FeaturesUpdated and FeaturesCreated events
[
{
"name": "webhookname",
"layerId": 0,
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"changesUrl": "https://olserver/myorgId/ArcGIS/rest/services/myService/FeatureServer/extractChanges?serverGens=[25166748,25166760]&async=true&returnDeletes=false&returnAttachments=false",
"events": ["FeaturesUpdated", "FeaturesCreated"]
}
]Example two: ServiceDefinitionChanged and LayerDefinitionChanged events
[
{
"name": "webhookname",
"orgId": "myorgId",
"serviceName": "myService",
"lastUpdatedTime": 1644613399009,
"events": ["ServiceDefinitionChanged", "LayerDefinitionChanged"]
}
]