Webhooks
How to access integration webhooks.
When you add an integration to your app, a webhook is automatically created so the integration can receive messages from third-party platforms.
In this guide, you'll learn how to access your integration webhooks using the Meya Console or the Meya CLI.
Related resources
Retrieving a webhook
Depending on the integration, you may need to add the webhook to the external platform's settings. For example, the Zendesk Support integration requires you to create an HTTP target using the integration's webhook URL.
How you retrieve the webhook depends on whether your computer is set up for local development with the Meya CLI or not.
Meya CLI
If your computer is set up for local Meya development, you can access your webhooks by running this command in a terminal:
meya webhooks
Meya Console
If you do your development using the Meya Console, determining a webhook URL is straightforward since they follow a standard format:
https://grid.meya.ai/gateway/v2/INTEGRATION_NAME/APP_ID/INTEGRATION_DOT_PATH
Let's take a look at where you can find the various parts of the URL.
1. App ID
In the web console, navigate to the app's Settings page. Near the top, you'll see the App ID.
2. Integration dot path
Navigate to the app's Integrations page. If the integration is listed there (not nested inside a folder), the dot path will be integration.INTEGRATION_NAME
. So in this example the Orb's dot path would be integration.orb
.
If the integration is inside a folder, the folder names become part of the dot path. So if a Dialogflow integration is inside a dialogflow
folder, which in turn is inside a google
folder, the dot path would be integration.google.dialogflow.dialogflow
.
3. Assemble the URL
Finally, select the appropriate integration webhook URL template from the table below and update it with the app ID and integration dot path.
Integration | Webhook format |
---|---|
Amazon Alexa | https://grid.meya.ai/gateway/v2/alexa/APP_ID/INTEGRATION_DOT_PATH |
API & Webhook | https://grid.meya.ai/gateway/v2/webhook/APP_ID/INTEGRATION_DOT_PATH |
Calendly | https://grid.meya.ai/gateway/v2/calendly/APP_ID/INTEGRATION_DOT_PATH |
Clearbit | https://grid.meya.ai/gateway/v2/clearbit/APP_ID/INTEGRATION_DOT_PATH |
Dialogflow | https://grid.meya.ai/gateway/v2/dialogflow/APP_ID/INTEGRATION_DOT_PATH |
Freshchat | https://grid.meya.ai/gateway/v2/freshchat/APP_ID/INTEGRATION_DOT_PATH |
Front | https://grid.meya.ai/gateway/v2/front/APP_ID/INTEGRATION_DOT_PATH |
Google Actions | https://grid.meya.ai/gateway/v2/google-actions/APP_ID/INTEGRATION_DOT_PATH |
Mailgun | https://grid.meya.ai/gateway/v2/mailgun/APP_ID/INTEGRATION_DOT_PATH |
Mandrill | https://grid.meya.ai/gateway/v2/mandrill/APP_ID/INTEGRATION_DOT_PATH |
Orb | https://grid.meya.ai/gateway/v2/orb/APP_ID/INTEGRATION_DOT_PATH |
Postmark | https://grid.meya.ai/gateway/v2/postmark/APP_ID/INTEGRATION_DOT_PATH |
Salesforce Cases | https://grid.meya.ai/gateway/v2/salesforce_cases/APP_ID/INTEGRATION_DOT_PATH |
Salesforce CRM | https://grid.meya.ai/gateway/v2/salesforce/APP_ID/INTEGRATION_DOT_PATH |
Salesforce Knowledge | https://grid.meya.ai/gateway/v2/salesforce_knowledge/APP_ID/INTEGRATION_DOT_PATH |
Salesforce Live Agent | https://grid.meya.ai/gateway/v2/liveagent/APP_ID/INTEGRATION_DOT_PATH |
Segment | https://grid.meya.ai/gateway/v2/segment/APP_ID/INTEGRATION_DOT_PATH |
Sendgrid | https://grid.meya.ai/gateway/v2/sendgrid/APP_ID/INTEGRATION_DOT_PATH |
Sensitive Data | https://grid.meya.ai/gateway/v2/sensitive_data/APP_ID/INTEGRATION_DOT_PATH |
Shopify | https://grid.meya.ai/gateway/v2/shopify/APP_ID/INTEGRATION_DOT_PATH |
Slack | https://grid.meya.ai/gateway/v2/slack/APP_ID/INTEGRATION_DOT_PATH |
Twilio | https://grid.meya.ai/gateway/v2/twilio/APP_ID/INTEGRATION_DOT_PATH |
Twilio Flex | https://grid.meya.ai/gateway/v2/twilio_flex/APP_ID/INTEGRATION_DOT_PATH |
Twilio Voice | https://grid.meya.ai/gateway/v2/twilio_voice/APP_ID/INTEGRATION_DOT_PATH |
Web v1 | https://grid.meya.ai/gateway/v2/webv1/INTEGRATION_DOT_PATH |
https://grid.meya.ai/gateway/v2/whatsapp/APP_ID/INTEGRATION_DOT_PATH | |
Wit | https://grid.meya.ai/gateway/v2/wit/APP_ID/INTEGRATION_DOT_PATH |
Zendesk Chat | https://grid.meya.ai/gateway/v2/zendesk_chat/APP_ID/INTEGRATION_DOT_PATH |
Zendesk Help Center | https://grid.meya.ai/gateway/v2/zendesk_help_center/APP_ID/INTEGRATION_DOT_PATH |
Zendesk Sunshine Conversations | https://grid.meya.ai/gateway/v2/sunshine-conversations/APP_ID/INTEGRATION_DOT_PATH |
Zendesk Support | https://grid.meya.ai/gateway/v2/zendesk_support/APP_ID/INTEGRATION_DOT_PATH |
Updated over 2 years ago