Webhook registration endpoint in Rest API - Mini Project: Build & Apply

Webhook Registration Endpoint

📖 Scenario: You are building a simple web service that allows users to register webhooks. A webhook is a URL where your service can send notifications when certain events happen.Users will send a POST request with their webhook URL and event type to register their webhook.

🎯 Goal: Create a webhook registration endpoint that accepts JSON data with a url and event, stores the webhook in a list, and returns a confirmation message.

📋 What You'll Learn

Create a list called webhooks to store registered webhooks.

Create a variable called allowed_events containing the strings 'order_created' and 'order_shipped'.

Create a POST endpoint /register-webhook that accepts JSON with url and event fields.

Validate that event is in allowed_events before storing.

Return a JSON response confirming registration with the webhook url and event.

💡 Why This Matters

🌍 Real World

Webhook registration endpoints are used in many web services to allow external systems to receive real-time notifications about events.

💼 Career

Understanding how to create and validate REST API endpoints is essential for backend developers and anyone working with web services.

1

Create the initial data structure

Create a list called webhooks to store webhook registrations.

Rest API

# Create a list called webhooks to store webhook registrations
# Your code here

Hint

Use square brackets [] to create an empty list named webhooks.

2

Add allowed events configuration

Create a list called allowed_events containing the strings 'order_created' and 'order_shipped'.

Rest API

webhooks = []
# Create a list called allowed_events with 'order_created' and 'order_shipped'
# Your code here

Hint

Use a list with the two event strings exactly as shown.

3

Create the webhook registration endpoint

Create a POST endpoint /register-webhook using Flask that accepts JSON data with url and event. Validate that event is in allowed_events. If valid, append a dictionary with keys 'url' and 'event' to webhooks. Return a JSON response with keys 'message', 'url', and 'event' confirming registration.

Rest API

webhooks = []
allowed_events = ['order_created', 'order_shipped']

from flask import Flask, request, jsonify
app = Flask(__name__)

# Create POST endpoint /register-webhook
# Your code here

Hint

Use Flask decorators and request.get_json() to get JSON data. Check if event is allowed before adding to webhooks.

4

Run the app and test output

Add the code to run the Flask app if this file is the main program. Then, print webhooks after registration to verify the webhook was stored.

Rest API

webhooks = []
allowed_events = ['order_created', 'order_shipped']

from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/register-webhook', methods=['POST'])
def register_webhook():
    data = request.get_json()
    url = data.get('url')
    event = data.get('event')
    if event not in allowed_events:
        return jsonify({'error': 'Event not allowed'}), 400
    webhooks.append({'url': url, 'event': event})
    return jsonify({'message': 'Webhook registered', 'url': url, 'event': event})

# Add code to run the app and print webhooks
# Your code here

Hint

Use the standard Flask app run block. Printing webhooks can be done in the endpoint or after running tests.

Practice

1.

What is the main purpose of a webhook registration endpoint in a REST API?

easy

A. To update the API documentation automatically

B. To send event data directly to all users

C. To store user login credentials securely

D. To let apps register their callback URL to receive event updates

Solution

1. Step 1: Understand webhook registration

   A webhook registration endpoint allows external apps to tell your system where to send event notifications.

2. Step 2: Identify the main function

   The main function is to register a callback URL and event type so your system knows where to send updates.

3. Final Answer:

   To let apps register their callback URL to receive event updates -> Option D

4. Quick Check:

   Webhook registration = register callback URL [OK]

Hint: Webhook registration means saving callback URLs for events [OK]

Common Mistakes:

• Confusing webhook registration with sending events
• Thinking it stores user credentials
• Assuming it updates documentation

2.

Which HTTP method is typically used to register a webhook endpoint?

easy

A. POST

B. GET

C. DELETE

D. PUT

Solution

1. Step 1: Recall HTTP methods for creating resources

   POST is used to send data to the server to create a new resource, like registering a webhook.

2. Step 2: Eliminate other methods

   GET retrieves data, DELETE removes data, PUT updates existing data. Registration is creation, so POST fits best.

3. Final Answer:

   POST -> Option A

4. Quick Check:

   Register webhook = POST request [OK]

Hint: Use POST to send data and create webhook registrations [OK]

Common Mistakes:

• Using GET instead of POST for registration
• Confusing PUT with POST
• Using DELETE by mistake

3.

Given this JSON payload sent to a webhook registration endpoint:
{"callback_url": "https://example.com/hook", "event": "order_created"}
What should the server respond if the registration is successful?

medium

A. {"status": "success", "message": "Webhook registered"}

B. {"error": "Invalid URL"}

C. {"status": "failed", "message": "Missing event type"}

D. {"status": "success", "message": "Webhook deleted"}

Solution

1. Step 1: Analyze the input payload

   The payload contains a valid callback URL and an event type, so it should be accepted.

2. Step 2: Determine expected success response

   On success, the server confirms registration with a success status and message.

3. Final Answer:

   {"status": "success", "message": "Webhook registered"} -> Option A

4. Quick Check:

   Valid input = success confirmation [OK]

Hint: Success means status success and confirmation message [OK]

Common Mistakes:

• Confusing error messages as success
• Ignoring missing fields
• Mixing registration and deletion messages

4.

Consider this snippet of a webhook registration handler in Python Flask:

from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/register', methods=['POST'])
def register_webhook():
    data = request.json
    if 'callback_url' not in data or 'event' not in data:
        return jsonify({'error': 'Missing fields'}), 400
    # Assume registration logic here
    return jsonify({'status': 'success', 'message': 'Webhook registered'})

What error will occur if the client sends an empty POST body?

medium

A. No error, returns success

B. TypeError because request.json is a string

C. TypeError because data is None and keys are accessed

D. 404 Not Found error

Solution

1. Step 1: Understand request.json behavior on empty body

   If the POST body is empty, request.json returns None, not a dictionary.

2. Step 2: Analyze the if condition

   The code tries to check keys in data, but data is None, so 'in' operation causes a TypeError.

3. Final Answer:

   TypeError because data is None and keys are accessed -> Option C

4. Quick Check:

   Empty body means request.json is None causing key access error [OK]

Hint: Empty JSON body makes request.json None, causing TypeError [OK]

Common Mistakes:

• Assuming empty body returns empty dict
• Expecting success without data
• Confusing error types

5.

You want to build a webhook registration endpoint that only accepts URLs starting with https:// and event types from a fixed list: ["order_created", "order_shipped"]. Consider this Python validation function:

def validate_webhook(data):
    callback = data.get('callback_url')
    event = data.get('event')
    if not callback.startswith('https://'):
        return False
    if event not in ['order_created', 'order_shipped']:
        return False
    return True

Which statement best describes its behavior?

hard

A. Correctly validates both URL scheme and event type

B. Fails if callback_url is missing, causing AttributeError

C. Allows any URL scheme, no validation done

D. Only checks event type, ignores URL

Solution

1. Step 1: Check callback_url usage

   The code calls startswith on callback without checking if callback is None, so if missing, it raises AttributeError.

2. Step 2: Verify event type check

   The event type check is correct, but the missing callback check causes failure before this.

3. Final Answer:

   Fails if callback_url is missing, causing AttributeError -> Option B

4. Quick Check:

   Missing callback_url causes error on startswith call [OK]

Hint: Check for None before calling string methods to avoid errors [OK]

Common Mistakes:

• Not checking if callback_url exists before startswith
• Assuming event type validation covers all errors
• Ignoring input validation order