Skip to content
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

Method Argument Alignment: chat.postMessage, chat.update #1495

Closed
8 tasks
AlexAtkinson opened this issue May 7, 2024 · 2 comments
Closed
8 tasks

Method Argument Alignment: chat.postMessage, chat.update #1495

AlexAtkinson opened this issue May 7, 2024 · 2 comments
Labels
question M-T: User needs support to use the project Version: 3x web-client

Comments

@AlexAtkinson
Copy link

The method chat.update requirs a channel id rather than a channel name, making it difficult to use. Please align its arguments with those of chat.postMessage, and allowing it to accept a channel name.

Category (place an x in each of the [ ])

  • [ X] slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)
@seratch
Copy link
Member

seratch commented May 10, 2024

Hello @AlexAtkinson, thank you for reaching out!

I understand that passing a channel name rather than its ID would be more convenient in many scenarios. However, our platform does not currently support channel name param for newer APIs (including chat.update). The channel name param is only available in the most long-lived APIs such as chat.postMessage and files.upload.

The reason behind this design policy change for newer APIs is inherent fragility of API calls due to the possibility of renaming at any time. This potential randomness often results in unexpected errors during API calls. While it might not make sense to you, our platform made this direction change to reduce such errors moving forward. For this reason, I am sorry to say this, but our platform team will not be incorporating any updates that allow APIs to accept channel names further.

I understand that this may not be the answer you were hoping for, but we greatly appreciate your understanding. Thank you so much again for taking the time to share this feedback.

@seratch seratch closed this as completed May 10, 2024
@AlexAtkinson
Copy link
Author

Thanks for the info. A blurb on in the docs would short circuit other like issues.

I would rather not be able to rename channels than loose channel name direct referencing, though. I think I've renamed a channel once.

Best,
A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question M-T: User needs support to use the project Version: 3x web-client
Projects
None yet
Development

No branches or pull requests

2 participants