2.4.0

Create Alert widget

2.52.0

createAlertWidget({
 programId: "<program id>",
 title: "<alert title>",
 text: "<alert text>",
 imageUrl: "<your image url>",
 linkUrl: "<link url to include on alert widget>",
 linkLabel: "<link label to show on alert widget>",
}).then(alertWidget => console.log(alertWidget))

Create Image Poll widget

2.52.0

createImagePollWidget({
 question: "<widget question>",
 programId: "xxxx",
 option: [{
   description: "<option description>",
   imageUrl: "<url>"
 }],
}).then(imagePollWidget => console.log(imagePollWidget))

Create Image Prediction widget

2.52.0

createImagePredictionWidget({
 question: "<widget question>",
 programId: "xxxx",
 options: [{
   description: "<option description>",
   imageUrl: "<url>"
 }],
}).then(widget => console.log(widget))

Create Prediction followup widget using prediction widget id, widget kind and correct option Id

2.52.0

createPredictionFollowUpWidget({
 widgetId: "yyyyy",
 widgetKind: WidgetKind.TEXT_PREDICTION,
 correctOptionId: "zzzz"
}).then(followUpWidget => console.log(followUpWidget))

Create Text Poll widget

2.52.0

createTextPollWidget({
 question: "<widget question>",
 programId: "xxxx",
 option: [{
   description: "<option description>"
 }],
}).then(textPollWidget => console.log(textPollWidget))

Create Text Prediction widget

2.52.0

createTextPredictionWidget({
 question: "<widget question>",
 programId: "xxxx",
 options: [{
   description: "<option description>"
 }],
}).then(widget => console.log(widget))

Delete a widget

2.52.0

deleteWidget({
 widgetId: "<widget question>",
 widgetKind: WidgetKind.TEXT_POLL,
}).then(res => console.log(res))

1.18.2

1.18.0

getWidgetInteractions({
   interactionUrl: "<url>"
}).then(interactions => console.log(interactions))

// OR
getWidgetInteractions({
   programId: "<program-id>",
   widgets: [{
     kind: WidgetKind.TEXT_POLL,
     id: "<widget-id>"
  }]
}).then(interactions => console.log(interactions))

// OR
getWidgetInteractions({
   programId: "<program-id>",
   widgetKinds: [ WidgetKind.TEXT_POLL, WidgetKind.TEXT_PREDICTION ]
}).then(interactions => console.log(interactions))

Fetch paginated List of Widgets filtered by widget status and kind

2.13.0

getWidgets({
  programId: "xxxx",
  status: "pending",
  widgetKinds: ["text-poll"],
  ordering: "recent",
  interactive: true,
  since: "2022-05-26T12:41:27.463Z"
}).then(res => console.log(res));

Publish a widget based on publish delay duration that would schedule a widget to be published after a given duration. When no publish duration is passed, widget would be instantly published.

2.52.0

publishWidget({
 widgetId: "<widget question>",
 widgetKind: WidgetKind.TEXT_POLL,
 delayDuration: "P0DT00H05M00S" // publish widget after 5 mins
}).then(res => console.log(res))

1.18.0

2.4.0

Update Image Prediction widget option

2.52.0

updateImagePredictionWidgetOption({
 widgetId: "xxxx",
 optionId: "<widget option id>",
 rewardItemId: "yyy-ccvv-qqqq",
 rewardItemAmount: 100,
 description: "<updated description>",
 isCorrect: true,
 imageUrl: "<url for option image>"
}).then(widget => console.log(widget))

Update Text Prediction widget option

2.52.0

updateTextPredictionWidgetOption({
 widgetId: "xxxx",
 optionId: "<widget option id>",
 rewardItemId: "yyy-ccvv-qqqq",
 rewardItemAmount: 100,
 description: "<updated description>",
 isCorrect: true
}).then(widget => console.log(widget))