A Page Messenger welcome screen can display a Get Started button. When this button is tapped, the Messenger Platform will send a messaging_postbacks event to your webhook. Pages that add the button may also configure their greeting text.

get_started is a property of the Messenger Profile API. For information on retrieving, setting, updating, and deleting get_started, see the Messenger Profile API Reference.

The welcome screen is only shown the first time the user interacts with the Page on Messenger.

Contents

Permissions

A page access token with pages_messaging permission is required to interact with this endpoint.

Apps in Development Mode, the welcome screen will only be visible to people with role on the app.

get_started Format

{ 
  "get_started":{
    "payload":"<GET_STARTED_PAYLOAD>"
  }
}

Properties

Property Type Description

payload

String

Payload sent back to your webhook in a messaging_postbacks event when the 'Get Started' button is tapped. 1000 character limit.

Rate Limit

Calls to the Messenger Profile API are limited to 10 API calls per 10 minute interval. This rate limit is enforced per Page.