This document shows you how to create an API Call Notification that pings an API endpoint when a new user signs up.
To follow the steps in this tutorial, you must understand how notifications work and have created a sign-up form as demonstrated in a previous tutorial.
Creating an API Call Notification and attatching it to a form is a three-step process:
app/api_calls/ping_example_com_on_user_sign_up.liquid
This defines a POST request to the endpoint with the newly created user's ID. In this example, the request's body is JSON, and to notify the endpoint about it, you set the
The API Call notification name is a file path relative to the
For app/api_calls/ping_example_com_on_user_sign_up.liquid - the bolded part is the name (physical_file_path).
To test your newly created API Call Notification, trigger it using the following query:
All parameters provided via GraphQL as a
This is how you can prepare the
Connect the API Call Notification you created with the sign-up form
Whenever a user successfully signs up, the
Congratulations! You have created an API Call Notification. Now you can learn about parsing an API response: Parsing an API Response
Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.