OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

messaging.whatsapp.meta

Meta WhatsApp Cloud API integration for inbound message processing and outbound replies.

  • Type: integration (integration)
  • Version: 1.0.0
  • Owners: platform.messaging
  • Tags: messaging, whatsapp, meta
  • field.key.label
    messaging.whatsapp.meta
    field.version.label
    1.0.0
    field.type.label
    integration (integration)
    field.title.label
    messaging.whatsapp.meta
    field.description.label

    Meta WhatsApp Cloud API integration for inbound message processing and outbound replies.

  • Type: integration (integration)
  • Version: 1.0.0
  • Owners: platform.messaging
  • Tags: messaging, whatsapp, meta
  • field.tags.label
    messaging,whatsapp,meta
    field.owners.label
    platform.messaging
    field.stability.label

    Meta WhatsApp Cloud API integration for inbound message processing and outbound replies.

    Source Definition

    export const messagingWhatsappMetaIntegrationSpec = defineIntegration({
    	meta: {
    		key: 'messaging.whatsapp.meta',
    		version: '1.0.0',
    		category: 'messaging',
    		title: 'WhatsApp Cloud API (Meta)',
    		description:
    			'Meta WhatsApp Cloud API integration for inbound message processing and outbound replies.',
    		domain: 'communications',
    		owners: ['platform.messaging'],
    		tags: ['messaging', 'whatsapp', 'meta'],
    		stability: StabilityEnum.Beta,
    	},
    	supportedModes: ['managed', 'byok'],
    	transports: [
    		{ type: 'rest', baseUrl: 'https://graph.facebook.com' },
    		{
    			type: 'webhook',
    			inbound: {
    				signatureHeader: 'x-hub-signature-256',
    				signingAlgorithm: 'hmac-sha256',
    			},
    		},
    	],
    	preferredTransport: 'rest',
    	supportedAuthMethods: [
    		{ type: 'bearer' },
    		{
    			type: 'webhook-signing',
    			algorithm: 'hmac-sha256',
    			signatureHeader: 'x-hub-signature-256',
    		},
    	],
    	capabilities: {
    		provides: [
    			{ key: 'messaging.inbound', version: '1.0.0' },
    			{ key: 'messaging.outbound', version: '1.0.0' },
    		],
    	},
    	configSchema: {
    		schema: {
    			type: 'object',
    			required: ['phoneNumberId'],
    			properties: {
    				phoneNumberId: {
    					type: 'string',
    					description: 'WhatsApp business phone number ID used for sends.',
    				},
    				apiVersion: {
    					type: 'string',
    					description: 'Optional Graph API version (e.g. v22.0).',
    				},
    			},
    		},
    		example: {
    			phoneNumberId: '1234567890',
    			apiVersion: 'v22.0',
    		},
    	},
    	secretSchema: {
    		schema: {
    			type: 'object',
    			required: ['accessToken', 'appSecret', 'verifyToken'],
    			properties: {
    				accessToken: {
    					type: 'string',
    					description: 'Meta access token for WhatsApp Cloud API calls.',
    				},
    				appSecret: {
    					type: 'string',
    					description: 'Meta app secret used for signature verification.',
    				},
    				verifyToken: {
    					type: 'string',
    					description: 'Webhook verify token used during challenge handshake.',
    				},
    			},
    		},
    		example: {
    			accessToken: 'EAAG***',
    			appSecret: '***',
    			verifyToken: 'contractspec-verify',
    		},
    	},
    	healthCheck: {
    		method: 'custom',
    		timeoutMs: 5000,
    	},
    	docsUrl: 'https://developers.facebook.com/docs/whatsapp',
    	constraints: {
    		rateLimit: {
    			rpm: 120,
    		},
    	},
    	byokSetup: {
    		setupInstructions:
    			'Create a Meta app with WhatsApp product enabled, add a business phone number, and provide API and webhook credentials.',
    		keyRotationSupported: false,
    		quotaTrackingSupported: false,
    	},
    });