Businesses
- GETSearch for businesses
- GETGet completion rate stats from your businesses
- GETStatistics for your connected businesses
- POSTCreate business
- GETBusiness information
- POSTUpdate business
- DELDelete business
- GETAdditional data for your business
- POSTSet additional data for your business
- GETGoogle attributes for your business
- POSTSet Google attributes for your business
- GETMore hours for your business
- POSTSet more hours for your business
- GETGoogle Services for your business
- DELDelete Google Services for your business
- POSTSet Google Services for your business
- POSTSet custom Google Services for your business
- GETGoogle Food Menus for your business
- POSTSet Google Food Menus for your business
- DELDelete Google Food Menus for your business
- GETGet Place Action Links
- POSTSet Place Action Links
- GETSubscriptions for your businessdeprecated
- POSTSubscribe a businessdeprecated
- POSTUnsubscribe a businessdeprecated
Business Fields
Messages
Custom Channels
Message Reply Templates
Messaging Settings
Custom Fields
Custom Fields Section
Custom Roles
Groups and Sections
Holidays
Organizations
Place Action Links
Reviews
- GETSearch for reviews
- PUTUpdate a review
- POSTPost a reply to a review
- PUTModify a reply to a review
- DELDelete the given reply to a review
- GETSearch for review reply templates
- GETAll available placeholders
- POSTCreate a review reply template
- DELDelete a review reply template
- GETFetch AI reply suggestion for reviews
Review analytics
Review Booster
Subscriptions
Users
Feedback Management
Webhooks
New message received
⚠️ Deprecated, please use the Message Created webhook instead, and filter on
sender_type=Consumer and status=Success to reproduce this webhook comportement.
This event is triggered when a business receives a new message sent by a Consumer. It is not triggered for messages sent as the business by a User.
The event payload contains the event type, the content of the message received, and additional information about the conversation.
Authorizations
The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.
Body
Show child attributes
Show child attributes
The id of the message.
The id of the parent conversation.
The date at which the message was sent or received, in the ISO 8601 format (ex: "2023-01-31 16:22:17.327878+00:00").
"2023-01-31 16:22:17.327878+00:00"
The type of the message:
- "Text" describes a simple text message.
- "Image" describes a message that only contains an image.
- "IgStoryReply" (for "Instagram" conversations) describes a notification of reply to an Instagram story.
- "IgStoryMention" (for "Instagram" conversations) describes a notification of a mention in an Instagram story.
- "Unsupported" describes a message whose content is not supported.
⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.
We recommend showing a "Unhandled content" placeholder to the user in place of the message ⚠️
Text, Image, Video, Audio, Document, IgStoryReply, IgStoryMention, Unsupported Describes the person that sent the Message:
- "User" indicates that the message was sent as the Business. Such messages can be sent by a Partoo user, via API, or directly on the messaging platform.
- "Consumer" indicates that the message was sent by a consumer, a client that wants to get in touch with the business.
- "Metadata" is reserved for special messages that appear in the Partoo inbox. They only give contextual information about the conversation, and are not shown to the consumer.
⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.
We recommend ignoring messages with unhandled sender_type ⚠️
User, Consumer, Metadata Name of the person sending the message
"Jane Doe"
The delivery status of the message. Messages send via Partoo are created with the status "Sending", and propagated to the messaging channel. If the message is sent successfully, the status is changed to "Success". If the messaging channel fails to send the message, the status changed to "Failed". A failed message can be retried using the /retry endpoint.
Sending, Success, Failed If the message has been deleted by the consumer on the messaging channel (for now, only "Instagram" messages can be deleted).
false
The text of the message.
For "User" messages sent via the Partoo application, the id of the user that sent the message.
The id of the message.
Deprecated, use id instead.
The id of the organization
The id of the business
The date at which the message was received format (ex: "2023-01-31T16:22:17.327878+00:00").
Deprecated, use date instead.
"2023-01-31T16:22:17.327878+00:00"
The url of the consumer's profile picture
"https://www.example.com/profile-picture.jpg"
The name of the consumer, can be empty. The format may differ depending on the platform of contact (ex: "John Doe", "John Doe (@johndoe)", "@johndoe", "", ...).
"John Doe"
The channel that the message is being sent to/from.
⚠️ New values may be added to this enum without prior notice and without following the classic depreciation cycle.
It is up to you to gracefully handle the case where new values are added.
Google, Facebook, Instagram, SMS, Whatsapp "Facebook"
message_received Response
Return a 200 status to indicate that the event was properly received
Was this page helpful?