Postscript

App · 20 actions

Grow and text your Shopify store's SMS subscribers in Postscript: add, find, tag and opt out subscribers, text them, send events to flows, and start workflows when someone opts in, opts out or texts the shop.

Actions

ActionWhat it does
Add subscriberSign a phone number up to the shop's texts through a keyword.
Create webhookHave Postscript send one kind of event, such as a subscriber opting in, to an https address you have.
Delete webhookDelete a webhook so Postscript stops sending to it.
Erase subscriber dataErase a person's data from Postscript for a privacy request, found by id, phone, email or Shopify customer.
Find subscriberLook up a subscriber by phone number (in any format) or email.
Get connected shopGet the Postscript shop the connection acts for: its id and name.
Get keywordGet one keyword with how many times it was texted in.
Get message requestCheck a text sent with 'Send text message': its status, and the sent text once Postscript has sent it.
Get sent messageGet a text Postscript sent, with what it said and the credits it used.
Get subscriberGet one subscriber with their tags, properties and whether the shop may text them promotions or order updates.
Get webhookGet one webhook with its event, address and headers.
List keywordsList the shop's active keywords, the words people text in to sign up, with how often each was used.
List subscribersList the shop's SMS subscribers, filtered by email, phone, Shopify customer or when they joined or changed.
List webhooksList the shop's webhooks: which event each sends, and where.
Send custom eventSend an event, such as QuizCompleted, that Postscript flows can start from or wait for, tied to a subscriber by id, phone or email.
Send test webhookHave Postscript send made-up data to every webhook of the shop for one event, to check the address receives it.
Send text messageText one existing subscriber who agreed to get the shop's texts.
Unsubscribe subscriberOpt a subscriber out of the shop's texts, by id or phone number, for example when they ask you to stop texting them.
Update subscriberAdd tags, set custom properties or give a subscriber an email.
Update webhookChange where a webhook sends, or add or change its headers.

Add subscriber

Sign a phone number up to the shop's texts through a keyword. Only add people who agreed to get marketing texts: Postscript texts them to confirm and adds them only once they reply. Until then the id returned is a pending one.

Inputs

Phone numberphone_numbertextRequired
Their mobile number in any format. Without a country code it is read as a US number.
KeywordkeywordtextRequired
The keyword they sign up through, which sets the reply they get. Pick one, or type the keyword.
Sourceorigintext
Where they signed up. Defaults to other.One of: other (Other (default)), website, social.
Emailemailtext
Their email, kept on the subscriber and used to find their Shopify customer.
Shopify customer IDshopify_customer_idnumber
The Shopify customer this phone number belongs to.
Tagstagslist
Tags to add, for segments. Pick from the tags on recent subscribers or type new ones.
Custom propertiespropertiesobject
Up to 20 keys and values to filter segments by: text, whole numbers, lists of text or dates.

Outputs

phone_numbertext
The phone number sent, in E.164
subscriberobject
The pending subscriber
subscriber_idtext
The pending subscriber's id
Example output
{
  "phone_number": "+14155550123",
  "subscriber": {
    "created_at": "2026-10-15T09:00:00Z",
    "data": {},
    "email": "jo@example.com",
    "id": "ps_pending_123",
    "phone_number": "+14155550123",
    "properties": {
      "birthday": "1991-01-01",
      "has_purchased": true
    },
    "ps_id": 42,
    "shopify_customer_id": 6123456789,
    "subscriptions": {
      "promotional": {
        "can_send": true
      },
      "transactional": {
        "can_send": true
      }
    },
    "tags": [
      "VIP"
    ],
    "updated_at": "2026-10-16T09:00:00Z"
  },
  "subscriber_id": "ps_pending_123"
}

Create webhook

Have Postscript send one kind of event, such as a subscriber opting in, to an https address you have.

Inputs

EventeventtextRequired
Which event to send.One of: shop.test (Test event (shop.test)), shop.incoming_message (Incoming message (shop.incoming_message)), shop.subscriber.opt_in (Subscriber opted in (shop.subscriber.opt_in)), shop.subscriber.opt_out (Subscriber opted out (shop.subscriber.opt_out)), shop.email_collected (Email collected (shop.email_collected)).
Addresscallback_urltextRequired
The https:// address to send it to.
Headersheadersobject
Header names and values Postscript adds to every delivery, such as a token your endpoint checks.

Outputs

webhookobject
The webhook
Example output
{
  "webhook": {
    "callback_url": "https://example.com/postscript",
    "created_at": "2026-10-15T09:00:00Z",
    "event": "shop.subscriber.opt_in",
    "headers": {},
    "id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
    "updated_at": "2026-10-15T09:00:00Z"
  }
}

Delete webhook

Delete a webhook so Postscript stops sending to it.

Inputs

Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
webhook_idtext
The webhook deleted
Example output
{
  "deleted": true,
  "webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675"
}

Erase subscriber data

Erase a person's data from Postscript for a privacy request, found by id, phone, email or Shopify customer. It opts them out too and can't be undone.

Inputs

Subscriber IDsubscriber_idtext
Their Postscript id.
Phone numberphone_numbertext
Their phone number, in any format.
Emailemailtext
Their email address.
Shopify customer IDshopify_customer_idtext
Their Shopify customer id.

Outputs

messagetext
Postscript's answer
redactedtrue/false
True once Postscript accepted it
Example output
{
  "message": "OK",
  "redacted": true
}

Find subscriber

Look up a subscriber by phone number (in any format) or email. Says whether one was found instead of failing.

Inputs

Phone numberphone_numbertext
Their phone number, such as (415) 555-0123 or +44 7700 900123. Used first when both are given.
Emailemailtext
Their email address.

Outputs

countnumber
How many matched
foundtrue/false
Whether a subscriber matched
subscriberobject
The subscriber; empty if none matched
subscriber_idtext
Their id; empty if none matched
Example output
{
  "count": 1,
  "found": true,
  "subscriber": {
    "created_at": "2026-10-15T09:00:00Z",
    "data": {},
    "email": "jo@example.com",
    "id": "s_1234567abcd",
    "phone_number": "+14155550123",
    "properties": {
      "birthday": "1991-01-01",
      "has_purchased": true
    },
    "ps_id": 42,
    "shopify_customer_id": 6123456789,
    "subscriptions": {
      "promotional": {
        "can_send": true
      },
      "transactional": {
        "can_send": true
      }
    },
    "tags": [
      "VIP"
    ],
    "updated_at": "2026-10-16T09:00:00Z"
  },
  "subscriber_id": "s_1234567abcd"
}

Get connected shop

Get the Postscript shop the connection acts for: its id and name.

Inputs

None.

Outputs

resource_typetext
What the key belongs to: shop or partner
shop_idtext
The shop's Postscript id
shop_nametext
The shop's name
Example output
{
  "resource_type": "shop",
  "shop_id": "shop_1234567abcde",
  "shop_name": "Acme"
}

Get keyword

Get one keyword with how many times it was texted in.

Inputs

Keywordkeyword_idtextRequired
The keyword. Pick one, or give its id (kw_...).

Outputs

keywordobject
The keyword
Example output
{
  "keyword": {
    "created_at": "2026-10-01T03:17:09.306630",
    "id": "kw_31afjew824892ks",
    "keyword": "JOIN",
    "triggered_count": 10,
    "updated_at": "2026-10-01T03:17:09.306639"
  }
}

Get message request

Check a text sent with 'Send text message': its status, and the sent text once Postscript has sent it.

Inputs

Message request IDmessage_request_idtextRequired
The id 'Send text message' returned.

Outputs

message_requestobject
The message request
senttrue/false
Whether Postscript has sent the text yet
sent_message_idtext
The sent text's id once sent; empty until then
statustext
Where the message is: processing, scheduled, sent and so on
Example output
{
  "message_request": {
    "body": "Your order has shipped!",
    "category": "promotional",
    "created_at": "2026-10-16T09:00:00Z",
    "id": "mr_1b2a005a386281c9",
    "phone": "+14155550123",
    "scheduled_at": "",
    "sent_message": {
      "body": "Acme: Your order has shipped!",
      "created_at": "2026-10-16T09:00:05Z",
      "credits_used": 1,
      "id": "sm_1b2a005a386281c9",
      "media_url": "",
      "phone": "+14155550123",
      "shop_id": "shop_1234567abcd",
      "subscriber_id": "s_1234567abcd"
    },
    "status": "sent",
    "status_code": 0,
    "subscriber_id": "s_1234567abcd",
    "updated_at": "2026-10-16T09:00:05Z"
  },
  "sent": true,
  "sent_message_id": "sm_1b2a005a386281c9",
  "status": "sent"
}

Get sent message

Get a text Postscript sent, with what it said and the credits it used.

Inputs

Sent message IDsent_message_idtextRequired
The sent text's id, from 'Get message request'.

Outputs

sent_messageobject
The sent text
Example output
{
  "sent_message": {
    "body": "Acme: Your order has shipped!",
    "created_at": "2026-10-16T09:00:05Z",
    "credits_used": 1,
    "id": "sm_1b2a005a386281c9",
    "media_url": "",
    "phone": "+14155550123",
    "shop_id": "shop_1234567abcd",
    "subscriber_id": "s_1234567abcd"
  }
}

Get subscriber

Get one subscriber with their tags, properties and whether the shop may text them promotions or order updates.

Inputs

Subscriber IDsubscriber_idtextRequired
The subscriber's Postscript id (it starts with s_), from 'Find subscriber', 'List subscribers' or a trigger.

Outputs

subscriberobject
The subscriber
Example output
{
  "subscriber": {
    "created_at": "2026-10-15T09:00:00Z",
    "data": {},
    "email": "jo@example.com",
    "id": "s_1234567abcd",
    "phone_number": "+14155550123",
    "properties": {
      "birthday": "1991-01-01",
      "has_purchased": true
    },
    "ps_id": 42,
    "shopify_customer_id": 6123456789,
    "subscriptions": {
      "promotional": {
        "can_send": true
      },
      "transactional": {
        "can_send": true
      }
    },
    "tags": [
      "VIP"
    ],
    "updated_at": "2026-10-16T09:00:00Z"
  }
}

Get webhook

Get one webhook with its event, address and headers.

Inputs

Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

webhookobject
The webhook
Example output
{
  "webhook": {
    "callback_url": "https://example.com/postscript",
    "created_at": "2026-10-15T09:00:00Z",
    "event": "shop.subscriber.opt_in",
    "headers": {},
    "id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
    "updated_at": "2026-10-15T09:00:00Z"
  }
}

List keywords

List the shop's active keywords, the words people text in to sign up, with how often each was used.

Inputs

None.

Outputs

countnumber
How many
keywordslist
The keywords
Example output
{
  "count": 1,
  "keywords": [
    {
      "created_at": "2026-10-01T03:17:09.306630",
      "id": "kw_31afjew824892ks",
      "keyword": "JOIN",
      "triggered_count": 10,
      "updated_at": "2026-10-01T03:17:09.306639"
    }
  ]
}

List subscribers

List the shop's SMS subscribers, filtered by email, phone, Shopify customer or when they joined or changed. Gets one page; run it again with the next page number to see more.

Inputs

Subscribed tosubscription_typetext
Promotional subscribers (the default), transactional ones, or all.One of: promotional (Promotional (default)), transactional, all.
Email isemailtext
Only the subscriber with exactly this email.
Email containsemail_containstext
Only subscribers whose email contains this, such as @acme.com.
Phone numberphone_numbertext
Only the subscriber with this phone number, in any format.
Shopify customer IDshopify_customer_idtext
Only the subscriber linked to this Shopify customer.
Joined aftercreated_afterdate and time
Only subscribers who joined after this time.
Joined beforecreated_beforedate and time
Only subscribers who joined before this time.
Changed afterupdated_afterdate and time
Only subscribers changed after this time.
Changed beforeupdated_beforedate and time
Only subscribers changed before this time.
Ordersorttext
How to sort them. Leave empty for Postscript's order.One of: created_at__desc (Newest first), created_at__asc (Oldest first), updated_at__desc (Recently changed first), updated_at__asc (Least recently changed first), phone_number__asc (Phone number, A to Z), phone_number__desc (Phone number, Z to A), shopify_customer_id__asc (Shopify customer ID, low to high), shopify_customer_id__desc (Shopify customer ID, high to low).
Pagepagenumber
Which page to get, from 1. The result says how many there are.At least 1.

Outputs

countnumber
How many on this page
has_moretrue/false
Whether there is a page after this one
pagenumber
This page's number
subscriberslist
The subscribers
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "subscribers": [
    {
      "created_at": "2026-10-15T09:00:00Z",
      "data": {},
      "email": "jo@example.com",
      "id": "s_1234567abcd",
      "phone_number": "+14155550123",
      "properties": {
        "birthday": "1991-01-01",
        "has_purchased": true
      },
      "ps_id": 42,
      "shopify_customer_id": 6123456789,
      "subscriptions": {
        "promotional": {
          "can_send": true
        },
        "transactional": {
          "can_send": true
        }
      },
      "tags": [
        "VIP"
      ],
      "updated_at": "2026-10-16T09:00:00Z"
    }
  ],
  "total_pages": 1
}

List webhooks

List the shop's webhooks: which event each sends, and where.

Inputs

None.

Outputs

countnumber
How many
webhookslist
The webhooks
Example output
{
  "count": 1,
  "webhooks": [
    {
      "callback_url": "https://example.com/postscript",
      "created_at": "2026-10-15T09:00:00Z",
      "event": "shop.subscriber.opt_in",
      "headers": {},
      "id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
      "updated_at": "2026-10-15T09:00:00Z"
    }
  ]
}

Send custom event

Send an event, such as QuizCompleted, that Postscript flows can start from or wait for, tied to a subscriber by id, phone or email.

Inputs

Event nameevent_typetextRequired
The event's name as flows show it, after the shop's name. Letters, digits and underscores only.
Subscriber IDsubscriber_idtext
The subscriber's Postscript id.
Phone numberphone_numbertext
The subscriber's phone number, in any format.
Emailemailtext
The subscriber's email.
Happened atoccurred_atdate and time
When it happened. Leave empty for now.
Detailspropertiesobject
Keys and values flows can filter on and put in texts: text, numbers, true or false, or dates.
Your event IDexternal_idtext
The event's id in your own system, if it has one.

Outputs

acceptedtrue/false
True once Postscript accepted it
event_idslist
The ids Postscript gave the event
event_typetext
The event's name
Example output
{
  "accepted": true,
  "event_ids": [
    "1234-abcd-5678"
  ],
  "event_type": "QuizCompleted"
}

Send test webhook

Have Postscript send made-up data to every webhook of the shop for one event, to check the address receives it.

Inputs

Eventeventtext
Which event to send a test of. Defaults to the test event.One of: shop.test (Test event (shop.test)), shop.incoming_message (Incoming message (shop.incoming_message)), shop.subscriber.opt_in (Subscriber opted in (shop.subscriber.opt_in)), shop.subscriber.opt_out (Subscriber opted out (shop.subscriber.opt_out)), shop.email_collected (Email collected (shop.email_collected)).

Outputs

eventtext
The event tested
messagetext
Postscript's answer
senttrue/false
True once Postscript accepted it
Example output
{
  "event": "shop.test",
  "message": "OK",
  "sent": true
}

Send text message

Text one existing subscriber who agreed to get the shop's texts. Postscript starts it with the shop's name, and holds a promotional text until the subscriber's waking hours.

Inputs

Subscriber IDsubscriber_idtext
Their Postscript id. Give this or the phone number.
Phone numberphone_numbertext
A subscriber's phone number, in any format.
Countrycountrytext
The two-letter country of a phone number written without a country code. Defaults to US.
MessagebodytextRequired
What to text them.
Kindcategorytext
Promotional (the default). Transactional and conversational need Postscript's approval first.One of: promotional (Promotional (default)), transactional, conversational.
Send atscheduled_atdate and time
A later time to send it. Leave empty to send now.
Image linkmedia_urltext
An https link to a JPEG, PNG or GIF up to 1 MB, sent as a picture message (MMS costs more).

Outputs

message_requestobject
The message request
message_request_idtext
The request's id, for 'Get message request'
sent_message_idtext
The sent text's id if already sent
statustext
Where it is: processing, scheduled, sent and so on
Example output
{
  "message_request": {
    "body": "Your order has shipped!",
    "category": "promotional",
    "created_at": "2026-10-16T09:00:00Z",
    "id": "mr_1b2a005a386281c9",
    "phone": "+14155550123",
    "scheduled_at": "",
    "sent_message": {
      "body": "Acme: Your order has shipped!",
      "created_at": "2026-10-16T09:00:05Z",
      "credits_used": 1,
      "id": "sm_1b2a005a386281c9",
      "media_url": "",
      "phone": "+14155550123",
      "shop_id": "shop_1234567abcd",
      "subscriber_id": "s_1234567abcd"
    },
    "status": "sent",
    "status_code": 0,
    "subscriber_id": "s_1234567abcd",
    "updated_at": "2026-10-16T09:00:05Z"
  },
  "message_request_id": "mr_1b2a005a386281c9",
  "sent_message_id": "sm_1b2a005a386281c9",
  "status": "sent"
}

Unsubscribe subscriber

Opt a subscriber out of the shop's texts, by id or phone number, for example when they ask you to stop texting them.

Inputs

Subscriber IDsubscriber_idtext
Their Postscript id. Give this or the phone number.
Phone numberphone_numbertext
Their phone number, in any format.

Outputs

messagetext
Postscript's answer
phone_numbertext
The phone number given, in E.164, if any
subscriber_idtext
The id given, if any
unsubscribedtrue/false
True once Postscript accepted it
Example output
{
  "message": "OK",
  "phone_number": "",
  "subscriber_id": "s_1234567abcd",
  "unsubscribed": true
}

Update subscriber

Add tags, set custom properties or give a subscriber an email. Tags only add, other properties are kept, and an email is saved only if they have none yet.

Inputs

Subscriber IDsubscriber_idtextRequired
The subscriber's Postscript id (it starts with s_), from 'Find subscriber', 'List subscribers' or a trigger.
Emailemailtext
Their email. Postscript keeps an email they already have.
Tagstagslist
Tags to add, for segments. Pick from the tags on recent subscribers or type new ones.
Custom propertiespropertiesobject
Keys and values to set; the subscriber's other properties stay. Up to 50 in all.

Outputs

subscriberobject
The subscriber
Example output
{
  "subscriber": {
    "created_at": "2026-10-15T09:00:00Z",
    "data": {},
    "email": "jo@example.com",
    "id": "s_1234567abcd",
    "phone_number": "+14155550123",
    "properties": {
      "birthday": "1991-01-01",
      "has_purchased": true
    },
    "ps_id": 42,
    "shopify_customer_id": 6123456789,
    "subscriptions": {
      "promotional": {
        "can_send": true
      },
      "transactional": {
        "can_send": true
      }
    },
    "tags": [
      "VIP",
      "Gold"
    ],
    "updated_at": "2026-10-16T09:00:00Z"
  }
}

Update webhook

Change where a webhook sends, or add or change its headers. The headers not named are kept.

Inputs

Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.
Addresscallback_urltext
A new https:// address. Leave empty to keep it.
Headersheadersobject
Header names and values Postscript adds to every delivery, such as a token your endpoint checks.

Outputs

webhookobject
The webhook
Example output
{
  "webhook": {
    "callback_url": "https://example.com/postscript",
    "created_at": "2026-10-15T09:00:00Z",
    "event": "shop.subscriber.opt_in",
    "headers": {
      "X-Token": "abc123"
    },
    "id": "a47606a1-5b39-4a81-9480-c2cb738ff675",
    "updated_at": "2026-10-15T09:00:00Z"
  }
}

On this page