Added

Implement the documents.added webhook to know when a document object is added.

Document objects are added when the API finds and retrieves documents from a newly-created user account, or when it finds new documents during periodic scanning.

Event

documents.added

Payload


account string uuid

ID of the account the document was added for.


user string uuid

ID of the user the account belongs to.


document string uuid

ID of the document that was added.


Examples

curl -X POST https://api.argyle.com/v1/webhooks \
  -u api_key_id:api_key_secret \
  -H "Content-Type: application/json" \
  -d '{"events": ["documents.added"],
       "secret": "<secret for signature verification>",
         "name": "documents.added",
          "url": "https://webhook.site/url"}'
{
  "event": "documents.added",
  "name": "A document was added",
  "data": {
    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
    "document": "4334r6e-a964-45eef6-b201-64464"
  }
}