On this page
Type reference
Built-in types: external services
Last updated
Services you call but do not run: payments, sign-in, email, SMS, push, maps and AI. Generated from external.proschi; component types explains how to read and extend them.
External #
A system run by someone else that the design calls over its API.
- Abstract. A node uses a type that extends it.
- Extends: Component
- Extended by: Third Party API, Payment Gateway, Auth Service, Notifier, Analytics Service, Google Maps, OpenAI
- Kind:
external - Protocol:
HTTP - Read:
GET,HEAD,OPTIONS,TRACE,CONNECT - Write:
POST,PUT,PATCH,DELETE - Statuses:
100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,425,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511 - Headers:
Accept,Accept-Encoding,Accept-Language,Accept-Ranges,Age,Allow,Authorization,Cache-Control,Connection,Content-Disposition,Content-Encoding,Content-Language,Content-Length,Content-Range,Content-Type,Cookie,Date,ETag,Expires,Host,If-Match,If-Modified-Since,If-None-Match,If-Range,If-Unmodified-Since,Last-Modified,Link,Location,Origin,Range,Referer,Retry-After,Server,Set-Cookie,User-Agent,Vary,Upgrade,WWW-Authenticate,Proxy-Authorization,Strict-Transport-Security,Content-Security-Policy,Access-Control-Allow-Origin,Access-Control-Allow-Methods,Access-Control-Allow-Headers,Access-Control-Allow-Credentials,Access-Control-Max-Age,Access-Control-Request-Method,Forwarded,X-Forwarded-For,X-Forwarded-Host,X-Forwarded-Proto,X-Real-IP,X-Request-Id,X-Correlation-Id,Traceparent,Tracestate,Idempotency-Key,X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset,RateLimit-Limit,RateLimit-Remaining,RateLimit-Reset,X-API-Key,X-Content-Type-Options,X-Frame-Options,Sec-WebSocket-Key,Sec-WebSocket-Accept,Sec-WebSocket-Protocol
Third Party API #
Another company's API, whose product does not matter.
- Extends: External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write:
SEND,NOTIFY, plus 4 from External - Statuses: 61 from External
- Headers: 69 from External
Payment Gateway #
A payment provider: authorizes, captures and refunds card payments.
- Extends: External › Component
- Extended by: Stripe, PayPal, Adyen, Braintree
- Kind:
external - Protocol:
HTTP - Read:
RETRIEVE, plus 5 from External - Write:
CHARGE,AUTHORIZE,CAPTURE,REFUND,VOID,PAYOUT, plus 4 from External - Statuses: 61 from External
- Headers: 69 from External
Stripe #
Stripe, the payments API.
- Extends: Payment Gateway › External › Component
- Kind:
external - Protocol:
HTTP - Read: 1 from Payment Gateway, 5 from External
- Write: 6 from Payment Gateway, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
PayPal #
PayPal, the online payments service.
- Extends: Payment Gateway › External › Component
- Kind:
external - Protocol:
HTTP - Read: 1 from Payment Gateway, 5 from External
- Write: 6 from Payment Gateway, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Adyen #
Adyen, the payments platform for cards and local payment methods.
- Extends: Payment Gateway › External › Component
- Kind:
external - Protocol:
HTTP - Read: 1 from Payment Gateway, 5 from External
- Write: 6 from Payment Gateway, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Braintree #
Braintree, PayPal's payments API for cards and wallets.
- Extends: Payment Gateway › External › Component
- Kind:
external - Protocol:
HTTP - Read: 1 from Payment Gateway, 5 from External
- Write: 6 from Payment Gateway, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Auth Service #
An identity provider: signs users in and issues and checks their tokens.
- Extends: External › Component
- Extended by: Auth0, Okta, AWS Cognito
- Kind:
external - Protocol:
HTTP - Read:
VALIDATE,VERIFY,INTROSPECT,USERINFO,JWKS, plus 5 from External - Write:
LOGIN,LOGOUT,TOKEN,REFRESH,REVOKE,REGISTER, plus 4 from External - Statuses: 61 from External
- Headers: 69 from External
Auth0 #
Auth0, the hosted identity provider.
- Extends: Auth Service › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from Auth Service, 5 from External
- Write: 6 from Auth Service, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Okta #
Okta, the identity and single sign-on provider.
- Extends: Auth Service › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from Auth Service, 5 from External
- Write: 6 from Auth Service, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Notifier #
A provider that delivers messages to people: email, SMS or push notifications.
- Abstract. A node uses a type that extends it.
- Extends: External › Component
- Extended by: Email Service, SMS Service, Push Service
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write:
SEND,NOTIFY, plus 4 from External - Statuses: 61 from External
- Headers: 69 from External
Email Service #
An email provider that sends the design's emails.
- Extends: Notifier › External › Component
- Extended by: SendGrid, Mailgun, AWS SES
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
SendGrid #
SendGrid, Twilio's email API.
- Extends: Email Service › Notifier › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Mailgun #
Mailgun, the email API.
- Extends: Email Service › Notifier › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
SMS Service #
An SMS provider that sends text messages.
- Extends: Notifier › External › Component
- Extended by: Twilio
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Twilio #
Twilio, the API for SMS, voice and messaging.
- Extends: SMS Service › Notifier › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Push Service #
A push notification provider that delivers to phones.
- Extends: Notifier › External › Component
- Extended by: APNs, FCM
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
APNs #
Apple Push Notification service, which delivers push notifications to Apple devices.
- Extends: Push Service › Notifier › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
FCM #
Firebase Cloud Messaging, which delivers push notifications to Android, iOS and the web.
- Extends: Push Service › Notifier › External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write: 2 from Notifier, 4 from External
- Statuses: 61 from External
- Headers: 69 from External
Analytics Service #
A product analytics provider that receives usage events.
- Extends: External › Component
- Kind:
external - Protocol:
HTTP - Read: 5 from External
- Write:
TRACK,IDENTIFY,PAGE,SCREEN,ALIAS, plus 4 from External - Statuses: 61 from External
- Headers: 69 from External
Google Maps #
Google Maps Platform: geocoding, directions, distances and map tiles.
- Extends: External › Component
- Kind:
external - Protocol:
HTTP - Read:
GEOCODE,DIRECTIONS,DISTANCE,PLACES,ROUTES,TILES, plus 5 from External - Write: 4 from External
- Statuses: 61 from External
- Headers: 69 from External
OpenAI #
OpenAI's API for language models and embeddings.