-
Notifications
You must be signed in to change notification settings - Fork 1
Add Custom Channel Event endpoints documentation #260
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Intercom-OpenAPI/fern/openapi-overrides.yml
Lines 4 to 6 in 7afd4f1
x-fern-sdk-group-name: | |
- admins | |
x-fern-sdk-method-name: identify |
x-fern-sdk-group-name
and x-fern-sdk-method-name
for each of the endpoints so they show up properly in the SDK?
49447c7
to
380b41a
Compare
@dsinghvi I've added |
fern/openapi-overrides.yml
Outdated
post: | ||
x-fern-sdk-group-name: | ||
- customChannelEvents | ||
x-fern-sdk-method-name: createNewConversation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we change this to just createConversation? suggestion from Matt @auroralimin
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Eclairemoy These are events and not REST actions, so it is a "new conversation" event. I can rename everything in the API to have event at the end of it, I didn't so far because the events was in the name of the group of endpoints, so it felt repetitive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about "notify", like "NotifyNewConversation", "NotifyMessage", etc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah that makes sense! these look good to me
Add documentation for the new API endpoints for Custom Channel Event, that are used on a closed beta to achieve "Fin over API" integrations.
380b41a
to
ca8bb06
Compare
Add documentation for the new API endpoints for Custom Channel Events, that are used on a closed beta to allow "Fin over API" types of integration.
The changes were tested using a Swagger editor:
Swagger.Editor.-.19.May.2025.mp4