Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›overwolf.campaigns

API Reference

  • Changelog
  • Overview

App Manifest

  • manifest.json
  • Validate your manifest

Available Game Events

  • Games IDs
  • Apex Legends
  • Call of Duty: Warzone
  • CS:GO
  • Dota 2
  • Final Fantasy XIV
  • Dota Underlords
  • Escape From Tarkov
  • Fortnite
  • Hearthstone
  • Heroes of the Storm
  • Legends of Runeterra
  • League of Legends
  • Minecraft
  • MTG Arena
  • Overwatch
  • Path of Exile
  • PUBG
  • PUBG Lite
  • Rainbow Six Siege
  • Rocket League
  • StarCraft II
  • Teamfight Tactics
  • Valorant
  • World of Tanks
  • World of Warcraft
  • World of Warships
  • Warframe
  • Various External APIs

Game Launchers Events

  • Launchers IDs
  • LOL Launcher

overwolf.benchmarking

  • overwolf.benchmarking

overwolf.campaigns

  • overwolf.campaigns.crossapp

overwolf.cryptography

  • overwolf.cryptography

overwolf.extensions

  • overwolf.extensions
  • overwolf.extensions.current
  • overwolf.extensions.sharedData
  • overwolf.extensions.io

overwolf.games

  • overwolf.games
  • overwolf.games.events
  • overwolf.games.inputTracking
  • overwolf.games.launchers
  • overwolf.games.launchers.events

overwolf.io

  • overwolf.io
  • overwolf.io.paths

overwolf.logitech

  • overwolf.logitech
  • overwolf.logitech.arx
  • overwolf.logitech.led

overwolf.media

  • overwolf.media
  • overwolf.media.audio
  • overwolf.media.replays
  • overwolf.media.videos
  • Highlights supported games

overwolf.os

  • overwolf.os
  • overwolf.os.tray

overwolf.profile

  • overwolf.profile
  • overwolf.profile.subscriptions

overwolf.settings

  • overwolf.settings
  • overwolf.settings.hotkeys
  • overwolf.settings.language
  • overwolf.settings.games

overwolf.social

  • overwolf.social
  • overwolf.social.reddit
  • overwolf.social.youtube
  • overwolf.social.discord
  • overwolf.social.gfycat
  • overwolf.social.twitter

overwolf.streaming

  • overwolf.streaming

overwolf.tobii

  • overwolf.tobii

overwolf.utils

  • overwolf.utils

overwolf.web

  • overwolf.web
  • overwolf.web.webserver
  • overwolf.web.websocket

overwolf.windows

  • overwolf.windows
Edit

overwolf.campaigns.crossapp API

Use this API to allow crossapp-promotions.

One app can promote another app and then get an indication for a successful conversion.
For example - an app can promote a video capture and sharing app and receive a notification as soon as the user shares a video from the promoted app.

Note that the Achievement Rewards app will only work on the Overwolf Client version 0.156.0.16 and above.

Methods Reference

  • overwolf.campaigns.crossapp.getAvailableActions()
  • overwolf.campaigns.crossapp.set()
  • overwolf.campaigns.crossapp.reportConversion()
  • overwolf.campaigns.crossapp.consumeConversions()

Events Reference

  • overwolf.campaigns.crossapp.onAvailableActionUpdated

Types Reference

  • overwolf.campaigns.crossapp.CrossAppCampaign Object
  • overwolf.campaigns.crossapp.CrossAppCampaignConversion Object
  • overwolf.campaigns.crossapp.GetCrossAppAvailableActionsResult Object
  • overwolf.campaigns.crossapp.GetCrossAppConversionsResult Object

getAvailableActions(callback)

Version added: 0.158

Receive all cross-app actions that target the currently running extension.

ParameterTypeDescription
callback(Result: GetCrossAppAvailableActionsResult) => voidReturns an array of cross-app actions

set(campaign, callback)

Version added: 0.158

Initiate or modify a cross-app campaign action for this extension.

You may modify an existing action by using the same id parameter. See CrossAppCampaign.id.

ParameterTypeDescription
campaignCrossAppCampaign object
callback(Result) => voidReports success or failure.

Callback argument: Success

Returns with the code

{"success":true}

reportConversion(conversionInfo, callback)

Version added: 0.158

Submit new conversion for a cross-app campaign.

ParameterTypeDescription
conversionInfoCrossAppCampaignConversion object
callback(Result) => voidReports success or failure.

Callback argument: Success

Returns with the code

{"success":true}

consumeConversions(callback)

Version added: 0.158

Consume all pending conversions for this extension. Consumed conversions are deleted.

ParameterTypeDescription
callbackGetCrossAppConversionsResult object

onAvailableActionUpdated

Called when an available action has updated (or added), with the following structure: CrossAppCampaign Object.

Version added: 0.158

Fired when current extension campaign is updated.

GetCrossAppAvailableActionsResult Object

ParameterTypeDescription
successbooleaninherited from the "Result" Object
errorstringinherited from the "Result" Object
actionsCrossAppCampaign[]

Example data: Success

{"success":true, "actions":[]}

CrossAppCampaign Object

Container that represent a shared data parameters.

ParameterTypeDescription
idstringAn id to identify the campaign (action/conversion). See notes.
actionstringThe type of action this cross-app campaign supports.This is a free-text string.
expirationnumberExpiration date expressed in milliseconds since epoch (Unix Time, UTC). See notes.
owner_app_uidstringThe UID of the app that owns the targeted cross-app campaign. Optional
target_apps_uidsstring[]An array of app UIDs this cross-app campaign targets. Optional
dataobjectInformation about the cross-app campaign. See notes.

Example object data

{
    "id": "xxxxxx_bbbbbbDxk", // fake
    "action": "ar-invite",
    "expiration": 1735733700000,
    "target_apps_uids": ["*"],
    "data": 
    {
        "name": "ar-campaign", // fake
        "iconUrl": "overwolf-extension://lkjsndfnnnnd.../campaigns/xxxxxx_bbbbbbDx/icon.svg",
        "text": "with The Branded Challenge!"
        "textColor": "E6E6E6"
        "title": "Win a cool Reward",
        "titleColor": "#B2A1E5",
        
    }
 }

id notes

"id" should be unique per an extension (two different extensions can use the same id).

expiration notes

e.g. Date.now() or (new Date()).getTime().

data notes

This is a free-form json object that gives more instructions on the required action.

CrossAppCampaignConversion Object

Container that represent a cross app campaign conversions.

ParameterTypeDescription
idstringThe ID of the cross-app campaign the conversion targets.
owner_app_uidstringThe UID of the app that owns the targeted cross-app campaign.
dataobjectConversion data for the specified action.
origin_app_uidobjectThe UID of the app that performed the conversion (the promoted app). Optional. See notes.
timestampnumberWhen the conversion took place. Optional. See notes.

origin_app_uid notes

Set by the Overwolf client when calling |consumeConversions|.

timestamp notes

Set by the Overwolf client when calling |consumeConversions|.

GetCrossAppConversionsResult Object

Container that represent a cross app conversions.

ParameterTypeDescription
successbooleaninherited from the "Result" Object
errorstringinherited from the "Result" Object
conversionsCrossAppCampaignConversion[]
Last updated on 2020-11-17 by eransharv
← overwolf.benchmarkingoverwolf.cryptography →
  • Methods Reference
  • Events Reference
  • Types Reference
  • getAvailableActions(callback)
  • set(campaign, callback)
  • reportConversion(conversionInfo, callback)
  • consumeConversions(callback)
  • onAvailableActionUpdated
  • GetCrossAppAvailableActionsResult Object
  • CrossAppCampaign Object
  • CrossAppCampaignConversion Object
  • GetCrossAppConversionsResult Object
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf