Skip to content

Configuration reference

Publish the config file with php artisan vendor:publish --tag=whatsapp-config. Most options can be set from .env.

Credentials

OptionEnvironment variableDescription
phone_number_idWHATSAPP_PHONE_NUMBER_IDThe phone number to send from
access_tokenWHATSAPP_ACCESS_TOKENA system user access token
business_account_idWHATSAPP_BUSINESS_ACCOUNT_IDNeeded for template management
app_idWHATSAPP_APP_IDNeeded to upload sample media for templates
tenantsExtra phone numbers. See Multiple phone numbers.

Webhooks

OptionEnvironment variableDefaultDescription
webhook_verify_tokenWHATSAPP_WEBHOOK_VERIFY_TOKENThe token you enter in Meta's webhook settings
webhook_secretWHATSAPP_WEBHOOK_SECRETYour App Secret, used to check webhook signatures
webhook.deduplicateWHATSAPP_WEBHOOK_DEDUPLICATEtrueSkip events that were already processed
webhook.deduplicate_for1440Minutes to remember processed events
webhook.cache_storeWHATSAPP_WEBHOOK_CACHE_STOREdefault storeCache store used to remember events

Requests

OptionEnvironment variableDefaultDescription
base_uriWHATSAPP_BASE_URIhttps://graph.facebook.com/v20.0Graph API URL, including the version
timeoutWHATSAPP_TIMEOUT30Request timeout in seconds
retry.timesWHATSAPP_RETRY_TIMES3Attempts per request for temporary failures (1 disables retries)
retry.sleepWHATSAPP_RETRY_SLEEP200Milliseconds before the first retry, doubled each time
rate_limitWHATSAPP_RATE_LIMIT30Messages per minute, per phone number
default_headersJSON headersHeaders added to every request

Messages

OptionEnvironment variableDefaultDescription
default_languageWHATSAPP_DEFAULT_LANGUAGEen_USTemplate language when none is given
media_storagestorage/app/whatsapp-mediaWhere downloaded media is saved

Message log

OptionEnvironment variableDefaultDescription
message_log.enabledWHATSAPP_MESSAGE_LOGfalseStore sent and received messages. See Message log.
message_log.connectionWHATSAPP_MESSAGE_LOG_CONNECTIONdefault connectionDatabase connection for the log

Debugging

OptionEnvironment variableDefaultDescription
debugWHATSAPP_DEBUGfalseLog full webhook payloads, which contain customers' messages

Released under the MIT License. Not affiliated with Meta or WhatsApp.