DESTINATION ACTIVATION


Every Destination requires activation before it can be used, and each Target type will require a different workflow to activate. This process is determined by the Target, and can require re-activation during the lifespan of the Destination.


Activation Response

{
    "actionTitle": "Destination does not require action.",
    "actionDescription": "This is an example message. Destination is Active.",
    "actionRequired": false
}

Destination JSON

Each Target requires/supports different data being stored in the Destination.

Facebook:

{
    "fb_resourceId": "234510293992583",
    "fb_encoderBrand": "encoder-brand",
    "fb_encoderModel": "encoder-model",
    "fb_encoderVersion": "encoder-version"
}

If intended to create Live Publications, you will need to provide Facebook with the details of your encoder. However, there are no checks in place on this information and you can submit any non-blank value for these properties.

Additionally, you may need to send Facebook a resourceId which will need to be the Page ID you wish to connect. If this is supposed to be a user’s timeline, you can leave this blank and it will be picked up during the activation process.

Note: Uploading VOD to a user’s timeline has been removed from Facebook. However, you can stream Live to a user’s timeline.

YouTube:

If intended to create VOD Publications, you will need to provide YouTube with the region of your account. Otherwise, no details are required.

{
    "yt_region": "..."
}

Custom:

Custom Destinations do not require any details, but can be configured to have static live stream details, which Publications can inherit from.

{
    "cstm_streamUrl": "...",
    "cstm_streamName": "...",
    "cstm_backupStreamUrl": "...",
    "cstm_backupStreamName": "..."
}

Twitter:

There are no required or optional properties for connecting a Twitter account.


Activation Processes

Custom

There are no necessary steps to activate a Custom Destination. They are active by default.

Facebook

  1. Create the Destination, optionally providing a resourceId in the Destination JSON.
  2. Call GET /destination/activate
  3. Go to www.facebook.com/device.
  4. Enter the code provided in Step 2 and authenticate with Facebook.
  5. Repeat step 2.

This should result in a confirmation that the Destination is now active.

YouTube

  1. Create the Destination, optionally providing a Region in the Destination JSON.
  2. Call GET /destination/activate
  3. Go to the provided URL in the response and authenticate with Google.
  4. Repeat step 2.

This should result in a confirmation that the Destination is now active.

Twitter

  1. Create the Destination.
  2. Call GET /destination/activate
  3. Go to the provided URL in the response and authenticate with Twitter.
  4. Repeat step 2.

This should result in a confirmation that the Destination is now active.