Sample webhook payload

Below is a sample webhook payload that will be posted to your endpoint. Note that this generally adheres to the JSON-API specification.

👍

The best way to use a webhook payload

Rather than relying on the individual fields that you receive in a webhook, we recommend using it as a prompt that an entity has changed.

When your application receives a Nutshell webhook, fetch the changed entity using our REST API to get the entire contact.

Use the events key to see what kind of change you are receiving, and then see the actors and payload keys for specifics on what made the change, and the details of the changed entity.

Sample payload

{
	"meta": {},
	"links": {
	"events.comments": {
		"href": "https://app.nutshell.com/rest/comments?parent_id={events.id}",
		"type": "comments"
	},
	"events.actor": {
		"href": "https://app.nutshell.com/rest/{events.actorType}/{events.actor}",
		"type": "actors"
	},
	"events.payloads": {
		"href": "https://app.nutshell.com/rest/{events.payloadType}/{events.payloads}",
		"type": "payloads"
	},
	"actors.teams": {
		"href": "https://app.nutshell.com/rest/teams/{actors.teams}",
		"type": "teams"
	},
	"payloads.accounts": {
		"href": "https://app.nutshell.com/rest/accounts/{payloads.accounts}",
		"type": "accounts"
	},
	"payloads.contacts": {
		"href": "https://app.nutshell.com/rest/contacts/{payloads.contacts}",
		"type": "contacts"
	},
	"payloads.tags": {
		"href": "https://app.nutshell.com/rest/tags/{payloads.tags}",
		"type": "tags"
	},
	"payloads.sources": {
		"href": "https://app.nutshell.com/rest/sources/{payloads.sources}",
		"type": "sources"
	},
	"payloads.owner": {
		"href": "https://app.nutshell.com/rest/{leads.ownerType}/{leads.owner}",
		"type": "owners"
	},
	"payloads.files": {
		"href": "https://app.nutshell.com/rest/leads/{leads.id}/files",
		"type": "files"
	},
	"payloads.relatedFiles": {
		"href": "https://app.nutshell.com/rest/leads/{leads.id}/relatedfiles",
		"type": "files"
	},
	"payloads.territory": {
		"href": "https://app.nutshell.com/rest/territories/{payloads.territory}",
		"type": "territories"
	},
	"payloads.stage": {
		"href": "https://app.nutshell.com/rest/stages/{payloads.stage}",
		"type": "stages"
	},
	"payloads.stageset": {
		"href": "https://app.nutshell.com/rest/leads/{leads.id}/stages",
		"type": "stagesets"
	},
	"payloads.creator": {
		"href": "https://app.nutshell.com/rest/creators/{payloads.creator}",
		"type": "creators"
	},
	"payloads.products": {
		"href": "https://app.nutshell.com/rest/products/{payloads.products}",
		"type": "products"
	},
	"payloads.productMaps": {
		"href": "https://app.nutshell.com/rest/productMaps/{payloads.productMaps}",
		"type": "productMaps"
	},
	"payloads.competitors": {
		"href": "https://app.nutshell.com/rest/competitors/{payloads.competitors}",
		"type": "competitors"
	},
	"payloads.competitorMaps": {
		"href": "https://app.nutshell.com/rest/competitorMaps/{payloads.competitorMaps}",
		"type": "competitorMaps"
	},
	"payloads.outcome": {
		"href": "https://app.nutshell.com/rest/outcomes/{payloads.outcome}",
		"type": "outcomes"
	},
	"payloads.watchers": {
		"href": "https://app.nutshell.com/rest/users/{payloads.watchers}",
		"type": "users"
	},
	"owners.teams": {
		"href": "https://app.nutshell.com/rest/teams/{owners.teams}",
		"type": "teams"
	}
	},
	"events": [
	{
		"id": "372059-events",
		"type": "events",
		"createdTime": 1506547948,
		"actorType": "users",
		"payloadType": "leads",
		"action": "create",
		"changes": [],
		"links": {
		"comments": [],
		"actor": "1-users",
		"payloads": [
			"123-leads"
		]
		}
	}
	],
	"actors": [
	{
		"id": "1-users",
		"type": "users",
		"name": "Bob Smith",
		"firstName": "Bob",
		"modifiedTime": 1497471322,
		"isEnabled": true,
		"isAdministrator": true,
		"isViewingRestricted": false,
		"emails": [
		"[email protected]"
		],
		"sendForUser": [
		{
			"id": "1",
			"email": "[email protected]"
		}
		],
		"emailSignature": "Thanks!\n",
		"phonecallerType": "clicktocall",
		"avatarUrl": "https://app.nutshell.com/avatar/users/1/1609/2a1933a80a49dd3005fb342a443236806cbb40addab951/1497322",
		"initials": "BS",
		"links": {
		"teams": [
			"3-teams",
			"7-teams",
			"15-teams"
		]
		}
	}
	],
	"payloads": [
	{
		"id": "643-leads",
		"type": "leads",
		"isCurrentUserWatching": false,
		"deletedTime": null,
		"name": "A Lead",
		"value": {
		"amount": 0,
		"currency": "USD",
		"formatted": ""
		},
		"number": "3351",
		"description": "A Lead",
		"createdTime": {
		"absoluteLocalizedString": "September 27, 2017",
		"timestamp": 1506547948,
		"value": "Today"
		},
		"closedTime": null,
		"dueTime": null,
		"anticipatedClosedTime": null,
		"ownerType": "users",
		"status": "open",
		"lastContactedTime": null,
		"pieState": "03",
		"isOverdue": false,
		"href": "https://app.nutshell.com/rest/leads/643-leads",
		"confidence": 10,
		"htmlUrl": "https://app.nutshell.com/lead/3351",
		"htmlUrlPath": "/lead/3351",
		"avatarUrl": "https://app.nutshell.com/include/images/lead-pies/103.png",
		"initials": null,
		"links": {
		"accounts": [],
		"contacts": [],
		"tags": [],
		"sources": [],
		"owner": "1-users",
		"files": [],
		"relatedFiles": [],
		"territory": null,
		"stage": "5-stages",
		"stageset": "1-stagesets",
		"creator": "1-users",
		"products": [],
		"productMaps": [],
		"competitors": [],
		"competitorMaps": [],
		"outcome": null,
		"watchers": []
		}
	}
	],
	"owners": [
	{
		"id": "1-users",
		"type": "users",
		"name": "Bob Smith",
		"firstName": "BS",
		"modifiedTime": 1497471322,
		"isEnabled": true,
		"isAdministrator": true,
		"isViewingRestricted": false,
		"emails": [
		"[email protected]"
		],
		"sendForUser": [
		{
			"id": "7",
			"email": "[email protected]"
		}
		],
		"emailSignature": "Thanks!\n",
		"phonecallerType": "clicktocall",
		"avatarUrl": "https://app.nutshell.com/avatar/users/1/1609/2a1933a8e070a49d4d3fd05b4a44472f32386b4aea2ddab951/1941322",
		"initials": "BS",
		"links": {
		"teams": [
			"3-teams",
			"7-teams",
			"15-teams"
		]
		}
	}
	]
}