Skip to content

Commit 5a5daa7

Browse files
authored
1 parent 0ebb01b commit 5a5daa7

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

docs/docs/api/rest/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -860,13 +860,19 @@ in your workflow's URL - it's the string `p_2gCPml` in
860860

861861
`event_name` **string** (optional)
862862

863-
The name of the event stream whose events you'd like to receive:
863+
**Only pass `event_name` when you're listening for events on a custom channel, with the name of the custom channel**:
864+
865+
```
866+
event_name=<custom_channel>
867+
```
868+
869+
See [the `this.$emit` docs](/components/api/#emit) for more information on how to emit events on custom channels.
870+
871+
Pipedream also exposes channels for logs and errors:
864872

865-
- `$errors`: any errors thrown by workflows or sources are emitted to this
873+
- `$errors`: Any errors thrown by workflows or sources are emitted to this
866874
stream
867-
- `default`: any events emitted by event sources (or from workflows, using
868-
`$send.emit()`) are included in this stream
869-
- `$logs`: any logs produced by **event sources** are emitted to this stream
875+
- `$logs`: Any logs produced by **event sources** are emitted to this stream
870876

871877
---
872878

@@ -926,11 +932,9 @@ POST /auto_subscriptions?event_name={event_name}&listener_id={receiving_source_i
926932

927933
The name of the event stream whose events you'd like to receive:
928934

929-
- `$errors`: any errors thrown by workflows or sources are emitted to this
935+
- `$errors`: Any errors thrown by workflows or sources are emitted to this
930936
stream
931-
- `default`: any events emitted by event sources (or from workflows, using
932-
`$send.emit()`) are included in this stream
933-
- `$logs`: any logs produced by **event sources** are emitted to this stream
937+
- `$logs`: Any logs produced by **event sources** are emitted to this stream
934938

935939
---
936940

0 commit comments

Comments
 (0)