DEV Community

Cover image for ๐Ÿš€ API Maker - Web-socket Notifications
API Makerยฎ
API Makerยฎ

Posted on

4 3 1 2

๐Ÿš€ API Maker - Web-socket Notifications

โญ List of Feature โญ

โœ… Manage events
โ–ธ The 'Web-socket events' page in API Maker allows the user to manage web-socket event names by adding, editing or deleting them.

โœ… Convert and Validate - Request body and query params
โ–ธ To subscribe the web-socket event, the Front-end developer needs to add the following code.

  • Subscribe/Register for the 'INSTANCES' event type.
  • Subscribe for the 'CUSTOM_APIS' event type.
  • Subscribe for the 'SYSTEM_APIS' event type.
  • Subscribe for the 'THIRD_PARTY_APIS' event type.
  • Subscribe for the 'CUSTOM_WS_EVENTS' event type.

โญ Event Types (eventType) โญ

๐Ÿ‘‰ INSTANCES
๐Ÿ‘‰ THIRD_PARTY_APIS
๐Ÿ‘‰ CUSTOM_APIS
๐Ÿ‘‰ SYSTEM_APIS
๐Ÿ‘‰ CUSTOM_WS_EVENTS


โญ API name (apiName) โญ

๐Ÿ‘‰ SCHEMA_GET_ALL
๐Ÿ‘‰ SCHEMA_GET_ALL_STREAM
๐Ÿ‘‰ SCHEMA_GET_BY_ID
๐Ÿ‘‰ SCHEMA_POST_BULK_INSERT
๐Ÿ‘‰ SCHEMA_MASTER_SAVE
๐Ÿ‘‰ SCHEMA_ARRAY_OPERATIONS
๐Ÿ‘‰ SCHEMA_UPDATE_MANY
๐Ÿ‘‰ SCHEMA_PUT_UPDATE_BY_ID
๐Ÿ‘‰ SCHEMA_PUT_REPLACE_BY_ID
๐Ÿ‘‰ SCHEMA_DEL_DELETE_BY_ID
๐Ÿ‘‰ SCHEMA_POST_QUERY
๐Ÿ‘‰ SCHEMA_POST_QUERY_STREAM
๐Ÿ‘‰ SCHEMA_POST_QUERY_DELETE
๐Ÿ‘‰ SCHEMA_POST_AGGREGATE
๐Ÿ‘‰ SCHEMA_POST_COUNT
๐Ÿ‘‰ SCHEMA_GET_DISTINCT
๐Ÿ‘‰ SCHEMA_POST_DISTINCT_QUERY

Generated APIs

๐Ÿ‘‰ GEN_GET_ALL
๐Ÿ‘‰ GEN_GET_ALL_STREAM
๐Ÿ‘‰ GEN_GET_BY_ID
๐Ÿ‘‰ GEN_POST_BULK_INSERT
๐Ÿ‘‰ GEN_MASTER_SAVE
๐Ÿ‘‰ GEN_ARRAY_OPERATIONS
๐Ÿ‘‰ GEN_UPDATE_MANY
๐Ÿ‘‰ GEN_PUT_UPDATE_BY_ID
๐Ÿ‘‰ GEN_PUT_REPLACE_BY_ID
๐Ÿ‘‰ GEN_DEL_DELETE_BY_ID
๐Ÿ‘‰ GEN_POST_QUERY
๐Ÿ‘‰ GEN_POST_QUERY_STREAM
๐Ÿ‘‰ GEN_POST_QUERY_DELETE
๐Ÿ‘‰ GEN_POST_AGGREGATE
๐Ÿ‘‰ GEN_POST_COUNT
๐Ÿ‘‰ GEN_GET_DISTINCT
๐Ÿ‘‰ GEN_POST_DISTINCT_QUERY

System APIs

๐Ÿ‘‰ EXECUTE_PLAIN_QUERY
๐Ÿ‘‰ ENCRYPT_DATA
๐Ÿ‘‰ DECRYPT_DATA
๐Ÿ‘‰ HASH_DATA
๐Ÿ‘‰ GET_TOKEN
๐Ÿ‘‰ CALL_EXTERNAL_API
๐Ÿ‘‰ GET_SECRET
๐Ÿ‘‰ GET_REDIS_KEY
๐Ÿ‘‰ SET_REDIS_KEY
๐Ÿ‘‰ REMOVE_REDIS_KEY
๐Ÿ‘‰ CUSTOM_USER_CACHING
๐Ÿ‘‰ RESET_REDIS_CACHE_DB
๐Ÿ‘‰ RESET_REDIS_CACHE_CUSTOM_APIS
๐Ÿ‘‰ RESET_REDIS_CACHE_SYSTEM_APIS
๐Ÿ‘‰ RESET_REDIS_CACHE_TP_APIS
๐Ÿ‘‰ GET_TABLE_META
๐Ÿ‘‰ EMIT_EVENT
๐Ÿ‘‰ EMIT_EVENT_WS
๐Ÿ‘‰ IS_VALID_DATA_FOR_TABLE
๐Ÿ‘‰ IS_VALID_DATA_FOR_CUSTOM_API
๐Ÿ‘‰ IS_VALID_DATA_FOR_THIRD_PARTY_API


โญ Single Click facilities โญ

โ–ธ Add API Version
โ–ธ Edit API Version
โ–ธ Remove API Version


Youtube video link

https://youtu.be/qf1yycHTkxM

Websites

https://apimaker.dev

API Docs link

https://docs.apimaker.dev/v1/docs/pages/web-socket-event-page.html

Follow on twitter

https://twitter.com/api_maker

Linked In

https://www.linkedin.com/company/api-maker

Postmark Image

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up

Top comments (0)

Postmark Image

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up