Allows to fetch the webhook configuration

GET /v1/Porting/Configuration/Webhook

Allows to fetch the webhook configuration

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • url string(uri) | null

      The URL of the webhook configuration request

    • port_in_target_url string(uri) | null

      The complete webhook url that will be called when a notification event for port in request or port in phone number happens

    • port_out_target_url string(uri) | null

      The complete webhook url that will be called when a notification event for a port out phone number happens.

    • notifications_of array[string] | null

      A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.

    • port_in_target_date_created string(date-time) | null

      Creation date for the port in webhook configuration

    • port_out_target_date_created string(date-time) | null

      Creation date for the port out webhook configuration

GET /v1/Porting/Configuration/Webhook
curl \
 --request GET 'https://numbers.twilio.com/v1/Porting/Configuration/Webhook' \
 --user "username:password"
Response examples (200)
{
  "url": "https://numbers.twilio.com/v1/Porting/Configuration/Webhook",
  "notifications_of": [
    "PortInWaitingForSignature",
    "PortInInProgress",
    "PortInCompleted",
    "PortInActionRequired",
    "PortInCanceled",
    "PortInExpired",
    "PortInPhoneNumberWaitingForSignature",
    "PortInPhoneNumberSubmitted",
    "PortInPhoneNumberPending",
    "PortInPhoneNumberCompleted",
    "PortInPhoneNumberRejected",
    "PortOutPhoneNumberCompleted"
  ],
  "port_in_target_url": "https://www.example.com/port-in",
  "port_out_target_url": "https://www.example.com/port-out",
  "port_in_target_date_created": "2024-05-14T13:49:04Z",
  "port_out_target_date_created": "2024-05-14T13:49:07Z"
}