Stream file modification events in a directory
Streams change events for a directory until the client disconnects.
The body is JSON lines (sent with Content-Type: text/plain): one event object per line, e.g. {"op":"WRITE","name":"main.go","path":"/app/src","error":null}. op is the fsnotify operation (CREATE, WRITE, REMOVE, RENAME or CHMOD, several can be joined with |), name the base name of the changed entry, path the directory containing it, and error is always null. A [keepalive] line (not JSON) is sent every 30 seconds.
Only the directory’s direct entries are watched. To also watch every subdirectory, including ones created later, end the path with /**. The stream reports subsequent changes without an initial snapshot. When a new directory is detected, synthetic CREATE events are emitted for entries already present inside it to cover changes before its watch was registered.
Authorizations
Sandbox access token created through POST /v1/token.
Path Parameters
Directory path to watch (append /** to watch subdirectories)
Query Parameters
Comma-separated substrings; events whose full path contains one are skipped
Response
JSON lines stream of change events
The response is of type string.