SetHITTypeNotification: Configure a HITType Notification

Description

Configure a notification to be sent when specific actions occur for the specified HITType.

Usage

SetHITTypeNotification(    hit.type, notification = NULL, active = NULL, 
                        keypair = credentials(), print = getOption('MTurkR.print'),
                        browser = getOption('MTurkR.browser'), 
                        log.requests = getOption('MTurkR.log'),
                        sandbox = getOption('MTurkR.sandbox'),
                        validation.test = getOption('MTurkR.test'))

Arguments

hit.type

A character string specifying the HITTypeId of the HITType for which notifications are being configured.

notification

A character string containing a URL query parameter-formatted Notification structure (e.g., returned by GenerateNotification).

active

A logical indicating whether the Notification is active or inactive.

keypair

A two-item character vector containing an AWS Access Key ID in the first position and the corresponding Secret Access Key in the second position. Set default with credentials.

Optionally print the results of the API request to the standard output. Default is TRUE.

browser

Optionally open the request in the default web browser, rather than opening in R. Default is FALSE.

log.requests

A logical specifying whether API requests should be logged. Default is TRUE. See readlogfile for details.

sandbox

Optionally execute the request in the MTurk sandbox rather than the live server. Default is FALSE.

validation.test

A logical specifying whether only the pre-request checks should be conducted and the request URL returned (without executing the request). Default is FALSE.

Value

A dataframe containing details of the Notification and whether or not the request was successfully executed by MTurk.

Details

Configure a notification to be sent to the requester whenever an event (specified in the Notification object) occurs. This is useful for receiving email notifications about, for example, when assignments are submitted or HITs are completed. Note: The API operation underlying SetHITTypeNotification and SendTestEventNotification has been deprecated by Amazon is not receiving ongoing development, but remains available for backward compatibility. setnotification() is an alias.

References

http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_SetHITTypeNotificationOperation.html{API Reference: Operation} http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/Concepts_NotificationsArticle.html{API Reference: Concept}

Examples

Run this code

a <- GenerateNotification("requester@example.com",event.type="HITExpired")
SetHITTypeNotification(hit.type="2FFNCWYB49F9BBJWA4SJUNST5OFSOW",notification=a,active=TRUE)

Run the code above in your browser using DataLab