RMrmfg
manufacturing-v1

Create Webhook Endpoint

Changed on

Register a URL for lifecycle events. The signing secret is returned once, here; store it to verify X-RMFG-Signature.

post/v1/webhook-endpoints

Request

  • Base URL
    https://api.rmfg.com
  • URL
    https://api.rmfg.com/v1/webhook-endpoints
  • Auth
    HTTP bearer

Request body

urlstring required

HTTPS URL that receives POSTed events.

eventsstring[] required

Event types to deliver to this endpoint: design.ready, design.failed, dfm_report.production_files.ready, dfm_report.production_files.failed, quote.ready, quote.failed, cart.checked_out, order.status_changed.

descriptionstring nullable

Response

Endpoint created; secret shown once.

idstring required
object'webhook_endpoint'
urlstring required
eventsstring[] required
descriptionstring nullable
activeboolean
secretstring nullable

Signing secret; returned only when the endpoint is created.

created_atstring date-time required
updated_atstring date-time nullable

Changes

  • 3568b01e288dRevision changes
    • warning

      added the new bend_program.completed enum value to the / response property for the response status

    • warning

      added the new bend_program.failed enum value to the / response property for the response status

  • b7e901150c5cRevision changes
    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the request property's minItems was increased to 1

    • breaking

      the request property's minLength was increased from 0 to 12

    • breaking

      the response property became optional for the status

    • warning

      the request property's maxLength was set to 2000

    • warning

      removed the optional property from the response with the status

    • warning

      added the new cart.checked_out enum value to the / response property for the response status

    • warning

      added the new design.failed enum value to the / response property for the response status

    • warning

      added the new design.ready enum value to the / response property for the response status

    • warning

      added the new dfm_report.production_files.failed enum value to the / response property for the response status

    • warning

      added the new dfm_report.production_files.ready enum value to the / response property for the response status

    • warning

      added the new order.status_changed enum value to the / response property for the response status

    • warning

      added the new quote.failed enum value to the / response property for the response status

    • warning

      added the new quote.ready enum value to the / response property for the response status

    • info

      api operation id create_endpoint_v1_webhook_endpoints_post removed and replaced with webhook_endpoints.create

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security RMFGAPIKey was removed from the API

    • info

      api tag manufacturing-v1 added

    • info

      api tag dropship-v1 removed

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value true was added for the status

    • info

      added the required property to the response with the status