Webhooks - Payloads (Feature Service)

URL:: https://<WebHooks-url>/Webhooks
Methods:: GET
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.

JSON Response examples for single event payloads

The following are examples of single event payloads:

The following are examples of multiple event payloads:

Example one: FeaturesCreated event

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "name": "webhookname",
    "orgId": "myorgId",
    "serviceName": "myService",
    "lastUpdatedTime": 1644613399009,
    "events": ["LayerSchemaChanged"]
  }
]

Example nine: LayerDefinitionChanged event

Use dark colors for code blocksCopy
[
  {
    "name": "webhookname",
    "orgId": "myorgId",
    "serviceName": "myService",
    "lastUpdatedTime": 1644613399009,
    "events": ["LayerDefinitionChanged"]
  }
]

Example ten: FeatureServiceDefinitionChanged event

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "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

Use dark colors for code blocksCopy
[
  {
    "name": "webhookname",
    "orgId": "myorgId",
    "serviceName": "myService",
    "lastUpdatedTime": 1644613399009,
    "events": ["ServiceDefinitionChanged", "LayerDefinitionChanged"]
  }
]