Skip to content

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

Merged
merged 1 commit into from
May 20, 2025

Conversation

auroralimin
Copy link
Contributor

@auroralimin auroralimin commented May 16, 2025

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

@auroralimin auroralimin marked this pull request as ready for review May 16, 2025 12:12
@Eclairemoy Eclairemoy self-requested a review May 16, 2025 12:15
Copy link
Contributor

@Eclairemoy Eclairemoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good :)

Copy link
Collaborator

@dsinghvi dsinghvi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@auroralimin

x-fern-sdk-group-name:
- admins
x-fern-sdk-method-name: identify
can you add relevant x-fern-sdk-group-name and x-fern-sdk-method-name for each of the endpoints so they show up properly in the SDK?

@auroralimin auroralimin force-pushed the aurora.wang/fin-over-api-channel branch 2 times, most recently from 49447c7 to 380b41a Compare May 19, 2025 14:18
@auroralimin
Copy link
Contributor Author

@dsinghvi I've added x-fern-sdk-group-name and x-fern-sdk-method-name for the new endpoints, let me know if there is any other override I'm supposed to be doing for the SDK generation!

@auroralimin auroralimin requested a review from dsinghvi May 19, 2025 14:44
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: createNewConversation
Copy link
Contributor

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

Copy link
Contributor Author

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.

Copy link
Contributor Author

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?

Copy link
Contributor

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.
@auroralimin auroralimin force-pushed the aurora.wang/fin-over-api-channel branch from 380b41a to ca8bb06 Compare May 20, 2025 08:52
@auroralimin auroralimin dismissed dsinghvi’s stale review May 20, 2025 09:16

Review was addressed.

@auroralimin auroralimin merged commit b6aeb65 into main May 20, 2025
8 checks passed
@auroralimin auroralimin deleted the aurora.wang/fin-over-api-channel branch May 20, 2025 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants