Skip to content

Docs: Adds conversation provider documentation #24

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

i-am-rad
Copy link

Pull Request Template

📋 Description

Please provide a short summary explaining your changes and the motivation behind them.

Conversation providers need a lot of documentation. This should help kickstart the things needed to build them and the nuansces known as of 05/28/2025.

  • Bug fix
  • New documentation
  • Update to existing docs
  • Other (please describe):

🧪 Related Issues

Link any related GitHub issues or discussions here (e.g. Closes #123).
#20

📝 Checklist

  • I’ve tested my changes locally (if applicable).
  • I’ve added sufficient documentation.
  • I’ve reviewed existing open PRs for potential conflicts.
  • [x I’ve followed the repository's contribution guidelines.

💬 Additional Comments

Add any additional context or screenshots here.

Copy link

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@yotomations
Copy link

is conversation provider a thing?!?

@@ -0,0 +1,160 @@
# Conversation Providers

HighLevel provides conversation providers in marketplace applications for creating custom SMS, Email, and Call providers.
Copy link

@shastrismitha shastrismitha Jun 27, 2025

Choose a reason for hiding this comment

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

HighLevel allows creation of conversation providers in marketplace applications for different channels(SMS, Email, Call, Custom)


Bulk Actions: Supported

#### Email Provider (extra)

Choose a reason for hiding this comment

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

Custom provider
Highlevel also supports creating custom conversation providers, which can be either text only[type=SMS] or a combination of images & text[type=Email]. An example of the latter would be Facebook/IG/Telegram messaging.
cc: @gauravkanted-ghl

Description: This adds an additional Email custom conversation provider.

1. Enter a Name
2. Type: Email

Choose a reason for hiding this comment

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

Type: Email/SMS, depending on the need


Add Inbound Message API: Use type "Email". "emailMessageId" in the response is the thread to respond to. "conversationProviderId" <b>is not required</b>.
https://marketplace.gohighlevel.com/docs/ghl/conversations/add-an-inbound-message

Choose a reason for hiding this comment

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

Update the status to Outbound message delivery status once its processed on your end.
https://marketplace.gohighlevel.com/docs/ghl/conversations/update-message-status


Add Inbound Message API: Use type "SMS". "conversationProviderId" <b>is required</b>.
https://marketplace.gohighlevel.com/docs/ghl/conversations/add-an-inbound-message

Choose a reason for hiding this comment

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

Update the status to Outbound message delivery status once its processed on your end.
https://marketplace.gohighlevel.com/docs/ghl/conversations/update-message-status


Add Inbound Message API: Use type "Custom". You can also set "altId". When you reply in the UI the conversation provider outbound payload will add "replyToAltId". "conversationProviderId" <b>is required</b>.
https://marketplace.gohighlevel.com/docs/ghl/conversations/add-an-inbound-message

Choose a reason for hiding this comment

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

Update the status to Outbound message delivery status once its processed on your end.
https://marketplace.gohighlevel.com/docs/ghl/conversations/update-message-status

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.

4 participants