Create a new UsageTrigger
Webhooks that notify you of usage thresholds
Create a new UsageTrigger
Path parameters
-
The SID of the Account that will create the resource.
Body
-
CallbackMethod string(http-method)
The HTTP method we should use to call
callback_url. Can be:GETorPOSTand the default isPOST.Values are
HEAD,GET,POST,PATCH,PUT, orDELETE. -
The URL we should call using
callback_methodwhen the trigger fires. -
FriendlyName string
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
-
Recurring string
The frequency of a recurring UsageTrigger. Can be:
daily,monthly, oryearlyfor recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.Values are
daily,monthly,yearly, oralltime. -
TriggerBy string
The field in the UsageRecord resource that should fire the trigger. Can be:
count,usage, orpriceas described in the UsageRecords documentation. The default isusage.Values are
count,usage, orprice. -
The usage value at which the trigger should fire. For convenience, you can use an offset value such as
+30to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a+as%2B. -
The usage category that the trigger should watch. Use one of the supported usage categories for this value.
Values are
a2p-registration-fees,agent-conference,answering-machine-detection,authy-authentications,authy-calls-outbound,authy-monthly-fees,authy-phone-intelligence,authy-phone-verifications,authy-sms-outbound,call-progess-events,calleridlookups,calls,calls-client,calls-globalconference,calls-inbound,calls-inbound-local,calls-inbound-mobile,calls-inbound-tollfree,calls-outbound,calls-pay-verb-transactions,calls-recordings,calls-sip,calls-sip-inbound,calls-sip-outbound,calls-transfers,carrier-lookups,conversations,conversations-api-requests,conversations-conversation-events,conversations-endpoint-connectivity,conversations-events,conversations-participant-events,conversations-participants,cps,flex-usage,fraud-lookups,group-rooms,group-rooms-data-track,group-rooms-encrypted-media-recorded,group-rooms-media-downloaded,group-rooms-media-recorded,group-rooms-media-routed,group-rooms-media-stored,group-rooms-participant-minutes,group-rooms-recorded-minutes,imp-v1-usage,lookups,marketplace,marketplace-algorithmia-named-entity-recognition,marketplace-cadence-transcription,marketplace-cadence-translation,marketplace-capio-speech-to-text,marketplace-convriza-ababa,marketplace-deepgram-phrase-detector,marketplace-digital-segment-business-info,marketplace-facebook-offline-conversions,marketplace-google-speech-to-text,marketplace-ibm-watson-message-insights,marketplace-ibm-watson-message-sentiment,marketplace-ibm-watson-recording-analysis,marketplace-ibm-watson-tone-analyzer,marketplace-icehook-systems-scout,marketplace-infogroup-dataaxle-bizinfo,marketplace-keen-io-contact-center-analytics,marketplace-marchex-cleancall,marketplace-marchex-sentiment-analysis-for-sms,marketplace-marketplace-nextcaller-social-id,marketplace-mobile-commons-opt-out-classifier,marketplace-nexiwave-voicemail-to-text,marketplace-nextcaller-advanced-caller-identification,marketplace-nomorobo-spam-score,marketplace-payfone-tcpa-compliance,marketplace-remeeting-automatic-speech-recognition,marketplace-tcpa-defense-solutions-blacklist-feed,marketplace-telo-opencnam,marketplace-truecnam-true-spam,marketplace-twilio-caller-name-lookup-us,marketplace-twilio-carrier-information-lookup,marketplace-voicebase-pci,marketplace-voicebase-transcription,marketplace-voicebase-transcription-custom-vocabulary,marketplace-whitepages-pro-caller-identification,marketplace-whitepages-pro-phone-intelligence,marketplace-whitepages-pro-phone-reputation,marketplace-wolfarm-spoken-results,marketplace-wolfram-short-answer,marketplace-ytica-contact-center-reporting-analytics,mediastorage,mms,mms-inbound,mms-inbound-longcode,mms-inbound-shortcode,mms-messages-carrierfees,mms-outbound,mms-outbound-longcode,mms-outbound-shortcode,monitor-reads,monitor-storage,monitor-writes,notify,notify-actions-attempts,notify-channels,number-format-lookups,pchat,pchat-users,peer-to-peer-rooms-participant-minutes,pfax,pfax-minutes,pfax-minutes-inbound,pfax-minutes-outbound,pfax-pages,phonenumbers,phonenumbers-cps,phonenumbers-emergency,phonenumbers-local,phonenumbers-mobile,phonenumbers-setups,phonenumbers-tollfree,premiumsupport,proxy,proxy-active-sessions,pstnconnectivity,pv,pv-composition-media-downloaded,pv-composition-media-encrypted,pv-composition-media-stored,pv-composition-minutes,pv-recording-compositions,pv-room-participants,pv-room-participants-au1,pv-room-participants-br1,pv-room-participants-ie1,pv-room-participants-jp1,pv-room-participants-sg1,pv-room-participants-us1,pv-room-participants-us2,pv-rooms,pv-sip-endpoint-registrations,recordings,recordingstorage,rooms-group-bandwidth,rooms-group-minutes,rooms-peer-to-peer-minutes,shortcodes,shortcodes-customerowned,shortcodes-mms-enablement,shortcodes-mps,shortcodes-random,shortcodes-uk,shortcodes-vanity,small-group-rooms,small-group-rooms-data-track,small-group-rooms-participant-minutes,sms,sms-inbound,sms-inbound-longcode,sms-inbound-shortcode,sms-messages-carrierfees,sms-messages-features,sms-messages-features-senderid,sms-outbound,sms-outbound-content-inspection,sms-outbound-longcode,sms-outbound-shortcode,speech-recognition,studio-engagements,sync,sync-actions,sync-endpoint-hours,sync-endpoint-hours-above-daily-cap,taskrouter-tasks,totalprice,transcriptions,trunking-cps,trunking-emergency-calls,trunking-origination,trunking-origination-local,trunking-origination-mobile,trunking-origination-tollfree,trunking-recordings,trunking-secure,trunking-termination,turnmegabytes,turnmegabytes-australia,turnmegabytes-brasil,turnmegabytes-germany,turnmegabytes-india,turnmegabytes-ireland,turnmegabytes-japan,turnmegabytes-singapore,turnmegabytes-useast,turnmegabytes-uswest,twilio-interconnect,verify-push,verify-totp,verify-whatsapp-conversations-business-initiated,video-recordings,voice-insights,voice-insights-client-insights-on-demand-minute,voice-insights-ptsn-insights-on-demand-minute,voice-insights-sip-interface-insights-on-demand-minute,voice-insights-sip-trunking-insights-on-demand-minute,wireless,wireless-orders,wireless-orders-artwork,wireless-orders-bulk,wireless-orders-esim,wireless-orders-starter,wireless-usage,wireless-usage-commands,wireless-usage-commands-africa,wireless-usage-commands-asia,wireless-usage-commands-centralandsouthamerica,wireless-usage-commands-europe,wireless-usage-commands-home,wireless-usage-commands-northamerica,wireless-usage-commands-oceania,wireless-usage-commands-roaming,wireless-usage-data,wireless-usage-data-africa,wireless-usage-data-asia,wireless-usage-data-centralandsouthamerica,wireless-usage-data-custom-additionalmb,wireless-usage-data-custom-first5mb,wireless-usage-data-domestic-roaming,wireless-usage-data-europe,wireless-usage-data-individual-additionalgb,wireless-usage-data-individual-firstgb,wireless-usage-data-international-roaming-canada,wireless-usage-data-international-roaming-india,wireless-usage-data-international-roaming-mexico,wireless-usage-data-northamerica,wireless-usage-data-oceania,wireless-usage-data-pooled,wireless-usage-data-pooled-downlink,wireless-usage-data-pooled-uplink,wireless-usage-mrc,wireless-usage-mrc-custom,wireless-usage-mrc-individual,wireless-usage-mrc-pooled,wireless-usage-mrc-suspended,wireless-usage-sms, orwireless-usage-voice.
curl \
-X POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json \
--user "username:password" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'CallbackMethod=HEAD&CallbackUrl=https%3A%2F%2Fexample.com&FriendlyName=string&Recurring=daily&TriggerBy=count&TriggerValue=string&UsageCategory=a2p-registration-fees'{
"CallbackMethod": "HEAD",
"CallbackUrl": "https://example.com",
"FriendlyName": "string",
"Recurring": "daily",
"TriggerBy": "count",
"TriggerValue": "string",
"UsageCategory": "a2p-registration-fees"
}{
"CallbackMethod": "HEAD",
"CallbackUrl": "https://example.com",
"FriendlyName": "string",
"Recurring": "daily",
"TriggerBy": "count",
"TriggerValue": "string",
"UsageCategory": "a2p-registration-fees"
}{
"account_sid": "string",
"api_version": "string",
"callback_method": "HEAD",
"callback_url": "https://example.com",
"current_value": "string",
"date_created": "string",
"date_fired": "string",
"date_updated": "string",
"friendly_name": "string",
"recurring": "daily",
"sid": "string",
"trigger_by": "count",
"trigger_value": "string",
"uri": "https://example.com",
"usage_category": "a2p-registration-fees",
"usage_record_uri": "string"
}{
"account_sid": "string",
"api_version": "string",
"callback_method": "HEAD",
"callback_url": "https://example.com",
"current_value": "string",
"date_created": "string",
"date_fired": "string",
"date_updated": "string",
"friendly_name": "string",
"recurring": "daily",
"sid": "string",
"trigger_by": "count",
"trigger_value": "string",
"uri": "https://example.com",
"usage_category": "a2p-registration-fees",
"usage_record_uri": "string"
}