[Components] heyy

[pipedream-component-development]

heyy

URLs

• https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#f5b81c3a-503c-4fad-86bc-e07e00d68aec

Webhook Sources

new-incoming-message-instant

Prompt

Emit new event when the business gets a new incoming message. No props are required.

URLs

• https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#eda04a28-4c5b-4709-a3f4-204dba6bcc18

Actions

send-whatsapp-message

Prompt

Sends a Whatsapp message to a contact. Requires the prop 'contact_id' to identify the contact, and 'message' for the content to send. An optional prop 'attachment' can be added to send a file along with the message.

URLs

• https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#642821e3-2537-4d55-91fd-8cbb606f3e7a

create-contact

Prompt

Creates a new contact for the business. Required props are 'name' and 'phone_number'. Optional props include 'email', 'address', and 'notes', which might be beneficial for providing additional information about the contact.

URLs

• https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#a1249b8d-10cf-446a-be35-eb8793ffa967

update-contact

Prompt

Updates the details of a contact under the business. 'contact_id' is a required prop to identify which contact to update, and at least one optional prop ('name', 'address', 'phone_number', 'email') must be provided, representing the details to be updated.

URLs

• https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#5a5ee22b-c16e-4d46-ae5d-3844b6501a34

[sergio-eliot-rodriguez]

Btw, the Heyy team recommended to use /v2 endpoints of the API.

The API documentation (use version v2.0):
...
One small thing, in the first example, I see you used v1.0, our latest is v2.0 (there are more endpoints there).

[jcortes]

Hi @sergio-eliot-rodriguez do you know if there is some kind of documentation about the webhooks, more exactly about how is the payload formated? thanks!

[sergio-eliot-rodriguez]

Per the emaill from Heyy, one has to reply to messages sent via Heyy's whats app channel, for it to open a time frame during which further messages can be sent:

Meta has some rules regarding WhatsApp Cloud API that you need to know:

1. To initiate a conversation with a contact you can only send a WhatsApp Template message verified by Meta, as you did well.
2. To send free-form messages (Not templates) the contact has to reply to the business, every time the contact replies to the business a 24-hour window is opened/updated,
   in this window the business can send free-form messages and templates. If the client doesn't reply and you try to send a free-form message anyway the message will not be delivered and you will get the following error - "Conversation expired, Send a message template to renew conversation"
3. There is another rule regarding Marketing Message Templates approved by Meta, If you try to send more than 2 Marketing templates in a 24-hour window they will not be delivered, you can reset the template limit by the contact answering to the business.

[vunguyenhung]

Hello everyone, I have tested this PR and there're some test cases failed or needed improvement.

Please check the test report below for more information
https://vunguyenhung.notion.site/Components-heyy-12dbf548bb5e818bbfd2f051bcecdd39

[jcortes]

Hi @vunguyenhung I've just added a regexp validation for the phone number property, so please try again with latest push, thanks!

[vunguyenhung]

Hi everyone, all test cases are passed! Ready for release!

Test report
https://vunguyenhung.notion.site/Components-heyy-12dbf548bb5e818bbfd2f051bcecdd39