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, 
                       verbose = getOption('MTurkR.verbose'), ...)

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.

verbose

Optionally print the results of the API request to the standard output. Default is taken from getOption('MturkR.verbose').

...

Additional arguments passed to request.

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

API Reference: Operation

API Reference: Concept

Examples

Run this code

# NOT RUN {
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