List webhook subscriptions
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Attributes
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the Webhook Subscription | Read-only Non-null |
target_url | string | The HTTPS URL that is notified. It must include a path, e.g. https://example.com/daylite/contact-created | Read-Write Non-null Required |
application_identifier | string | Identifier of the app that created the subscription | Read-only Non-null |
event | string | The record type and operation, as type.operation, e.g. contact.insert. See Events | Read-Write Non-null Required |
Subscriptions belong to the account: every user in the account can see them, whichever user or app created them.
Events
An event is a record type and an operation, written type.operation, e.g. contact.insert or task.update. Each subscription is for one event; subscribe several times to receive several events.
| Operation | Sent when a record is |
|---|---|
insert | created |
update | changed |
trash | moved to the trash |
delete | permanently deleted |
| Record type |
|---|
appointment |
category |
company |
contact |
email |
form |
form_definition |
group |
keyword |
note |
opportunity |
project |
relationship |
resource |
role |
role_type |
task |
team |
user |
Notifications
When the event happens, Daylite sends a POST request to the subscription's target_url with a JSON body containing the URL of the record:
{ "resource_url": "https://api.marketcircle.net/v1/contacts/1000" }The notification doesn't include the record's data or the event name. Fetch the record from resource_url to get its current state; after a delete event, the record no longer exists. To tell events apart, give each subscription its own target_url.
Delivery and failures
Respond with a 2xx status to confirm you received a notification.
- If delivery fails (any other status, or the request can't be completed), Daylite tries again about 1 minute and then about 5 minutes later, for up to 3 attempts per notification.
- If your endpoint responds with
410 Gone, the subscription is deleted and no further notifications are sent. - After 10 failed deliveries in a row, the subscription is deactivated and the account's admins are emailed. It can be reactivated from the webhook settings in Daylite.