Show a port-out event

GET 
/portouts/events/:id

Show a specific port-out event.

Path Parameters

id uuidrequired

Identifies the port-out event.

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Uniquely identifies the event.

event_type string

Possible values: [portout.status_changed, portout.foc_date_changed, portout.new_comment]

Identifies the event type

portout_id uuid

Identifies the port-out order associated with the event.

available_notification_methods string[]

Possible values: [email, webhook]

Indicates the notification methods used.

payload_status string

Possible values: [created, completed]

The status of the payload generation.

payload

object

oneOf

• WebhookPortoutStatusChangedPayload
• WebhookPortoutNewCommentPayload
• WebhookPortoutFocDateChangedPayload

The webhook payload for the portout.status_changed event

id uuid

Identifies the port out that was moved.

status string

Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

The new status of the port out.

phone_numbers string[]

Phone numbers associated with this port-out order

carrier_name string

Carrier the number will be ported out to

spid string

The new carrier SPID.

user_id uuid

Identifies the user that the port-out order belongs to.

subscriber_name string

The name of the port-out's end user.

rejection_reason string

The reason why the order is being rejected by the user. If the order is authorized, this field can be left null

attempted_pin string

The PIN that was attempted to be used to authorize the port out.

The webhook payload for the portout.new_comment event

id uuid

Identifies the comment that was added to the port-out order.

portout_id uuid

Identifies the port-out order that the comment was added to.

user_id uuid

Identifies the user that added the comment.

comment string

The body of the comment.

The webhook payload for the portout.foc_date_changed event

id uuid

Identifies the port-out order that have the FOC date changed.

user_id string

Identifies the organization that port-out order belongs to.

foc_date date-time

ISO 8601 formatted date indicating the new FOC date.

record_type string

Identifies the type of the resource.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "event_type": "portout.status_changed",
    "portout_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
    "available_notification_methods": [
      "email"
    ],
    "payload_status": "created",
    "payload": {},
    "record_type": "portout_event",
    "created_at": "2021-03-19T10:07:15.527000Z",
    "updated_at": "2021-03-19T10:07:15.527000Z"
  }
}

404: Not found

500: Internal server error

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/portouts/events/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200

---

{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "event_type": "portout.status_changed",
    "portout_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
    "available_notification_methods": [
      "email"
    ],
    "payload_status": "created",
    "payload": {},
    "record_type": "portout_event",
    "created_at": "2021-03-19T10:07:15.527000Z",
    "updated_at": "2021-03-19T10:07:15.527000Z"
  }
}