Fetch and instance of a usage-trigger

GET /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json

Webhooks that notify you of usage thresholds

Fetch and instance of a usage-trigger

Path parameters

  • AccountSid string Required

    The SID of the Account that created the UsageTrigger resource to fetch.

  • Sid string Required

    The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that this trigger monitors

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • api_version string | null

      The API version used to create the resource

    • callback_method string(http-method) | null

      The HTTP method we use to call callback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • callback_url string(uri) | null

      he URL we call when the trigger fires

    • current_value string | null

      The current value of the field the trigger is watching

    • date_created string(date-time-rfc-2822) | null

      The RFC 2822 date and time in GMT that the resource was created

    • date_fired string(date-time-rfc-2822) | null

      The RFC 2822 date and time in GMT that the trigger was last fired

    • date_updated string(date-time-rfc-2822) | null

      The RFC 2822 date and time in GMT that the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the trigger

    • recurring string | null

      The frequency of a recurring UsageTrigger

      Values are daily, monthly, yearly, or alltime.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UT[0-9a-fA-F]{32}$.

    • trigger_by string | null

      The field in the UsageRecord resource that fires the trigger

      Values are count, usage, or price.

    • trigger_value string | null

      The value at which the trigger will fire

    • uri string(uri) | null

      The URI of the resource, relative to https://api.twilio.com

    • usage_category string | null

      The usage category the trigger watches

      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, or wireless-usage-voice.

    • usage_record_uri string | null

      The URI of the UsageRecord resource this trigger watches
GET /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json 
curl \
 -X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json \
 --user "username:password"
Response examples (200) 
{
  "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"
}
Response examples (200) 
{
  "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"
}