Skip to main content

​
How it works

Watermelon sends real-time events to any external API you choose through webhooks. You create a webhook via the API and select which entity you want to receive conversation or contact, or contact with fields. Each webhook sends one entity type per event, and you can set up multiple webhooks if you want to receive different types. When an event occurs, Watermelon forwards the full payload to your endpoint within a few seconds.

​
Create a webhook

create a webhook using the Watermelon API
  • Use entity id 1 for conversation object and entity id 2 for contact objects,
  • The following actions are supported create, update which are action id 1 and 2
  • Finaly use the verb id which is supported by your API
The action id represents the action that is happening in Watermelon action id 1 together with entity id 1 means. When a conversation is created run this webhook, or 1 and 2 which means when a new contact has been created in Watermelon run this webhook
Create Webhook Body Example 
{
  "verb_id": 3, //POST
  "entity_id": 1, //Conversation 
  "url": "https://yourdomain.com/your-endpoint",
  "action_id": 2, // (Update action) when a conversation is updated run this webhook
}'
If you prefer a no-code way to connect Watermelon with other tools, you can use our integrations with Zapier. In zapier there is more extensive support for messaging and preset triggers like forwarding

​
Endpoint URL

For the endpoint URL, set up an HTTPS endpoint that can accept webhook requests with a POST method:
  • Handles POST requests with a JSON payload
  • Returns a successful status code (2XX) or bad request codes (4xx) internal server errors (5xx) will not be resolved
Make sure your webhook is correctly setup using the following object
A webhook endpoint has a window of roughly 500 ms to 2 seconds to process and respond to an event.

​
Rquest failures & Retries

  • There are no retries
  • Your endpoint must handle downtime on your side if needed
  • If you require retry logic, you can implement it in your own endpoint.

​
Example Webhook Events

Conversation Webhook Example: 
{
  "archived": "datetime|null",
  "caller_id": "int64",
  "chatbot_enabled": "bool",
  "company_id": "int64",
  "created_at": "datetime|null",
  "deleted_at": "datetime|null",
  "id": "int64",
  "is_closed": "bool",
  "messages": "Message[]",
  "new": "bool",
  "no_matches_count": "int64",
  "out_of_office_replied": "bool",
  "service": "string",
  "team_id": "int64",
  "updated_at": "datetime|null",
  "user_id": "int64",
  "webchat_socket_channel": "string"
}
Contact Webhook Example 
{
  "avatar": "string|null",
  "company_id": "int64",
  "created_at": "datetime|null",
  "email_address": "string|null",
  "fields": "Field[]",
  "first_name": "string|null",
  "from_email": "bool|null",
  "from_integration": "bool|null",
  "from_whatsapp": "bool|null",
  "id": "int64",
  "integration": "string|null",
  "last_name": "string|null",
  "status": "string",
  "telephone_number": "string|null",
  "updated_at": "datetime|null"
}