Webhooks

Webhooks allow external services to be notified when certain events happen in Edgewise. When the specified events happen, we’ll send a POST request to each of the URLs you provide.

You can subscribe to individual, many, or all events. The webhook payload will include metadata about the event as well as the organization subscribed to the webhook; which can assist in routing the received message.

The event ID can be used for idempotency to ensure the same message is not processed more than once.

Example Events

Event data is a subset of the fields found in our GraphQL API responses.

lead.created

{
  "event": {
    "id": "evt_j6zlrENifGXpbDT",
    "name": "lead.created",
    "dispatchedAt": "2021-11-04T12:40:00"
  },
  "organization": {
    "id": "1234",
    "name": "Avengers"
  },
  "data": {
    "id": "5678",
    "name": "Tony Stark",
    "email": "tony@starkenterprises.com",
    "phone": "+15551234567",
    "status": "NEW",
    "source": "WEB_DIRECT",
    "isAgent": false,
    "address": {
      "thoroughfare": "20 W 34th St.",
      "locality": "New York",
      "administrativeArea": "NY",
      "postalCode": "10001"
    },
    "project": {
      "id": "9012",
      "title": "Acme Condos",
      "slug": "acme-condos"
    },
    "assignee": {
      "id": "3456",
      "fullName": "Nick Fury"
    }
  }
}

Adding a webhook

Webhooks are added under organization settings. A reference to the subscribed organization will be included in the webhook payload.